[ aws . configservice ]

put-organization-conformance-pack

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 .

Note

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-organization-conformance-pack
--organization-conformance-pack-name <value>
[--template-s3-uri <value>]
[--template-body <value>]
[--delivery-s3-bucket <value>]
[--delivery-s3-key-prefix <value>]
[--conformance-pack-input-parameters <value>]
[--excluded-accounts <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-conformance-pack-name (string)

Name of the organization conformance pack you want to create.

--template-s3-uri (string)

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

Note

You must have access to read Amazon S3 bucket.

--template-body (string)

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.

--delivery-s3-bucket (string)

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 .

--delivery-s3-key-prefix (string)

The prefix for the Amazon S3 bucket.

--conformance-pack-input-parameters (list)

A list of ConformancePackInputParameter objects.

(structure)

Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

ParameterName -> (string)

One part of a key-value pair.

ParameterValue -> (string)

Another part of the key-value pair.

Shorthand Syntax:

ParameterName=string,ParameterValue=string ...

JSON Syntax:

[
  {
    "ParameterName": "string",
    "ParameterValue": "string"
  }
  ...
]

--excluded-accounts (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

OrganizationConformancePackArn -> (string)

ARN of the organization conformance pack.