configservice_put_organization_conformance_pack: Deploys conformance packs across member accounts in an AWS...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

Deploys conformance packs across member accounts in an AWS Organization.

Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

AWS Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.

You can create 6 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

Usage

1
2
3
4
configservice_put_organization_conformance_pack(
  OrganizationConformancePackName, TemplateS3Uri, TemplateBody,
  DeliveryS3Bucket, DeliveryS3KeyPrefix, ConformancePackInputParameters,
  ExcludedAccounts)

Arguments

OrganizationConformancePackName

[required] Name of the organization conformance pack you want to create.

TemplateS3Uri

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket.

TemplateBody

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

DeliveryS3Bucket

Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config stores intermediate files while processing conformance pack template.

The delivery bucket name should start with awsconfigconforms. For example: "Resource": "arn:aws:s3:::your_bucket_name/*". For more information, see Permissions for cross account bucket access.

DeliveryS3KeyPrefix

The prefix for the Amazon S3 bucket.

ConformancePackInputParameters

A list of ConformancePackInputParameter objects.

ExcludedAccounts

A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.

Value

A list with the following syntax:

1
2
3
list(
  OrganizationConformancePackArn = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
svc$put_organization_conformance_pack(
  OrganizationConformancePackName = "string",
  TemplateS3Uri = "string",
  TemplateBody = "string",
  DeliveryS3Bucket = "string",
  DeliveryS3KeyPrefix = "string",
  ConformancePackInputParameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string"
    )
  ),
  ExcludedAccounts = list(
    "string"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.