[ aws . configservice ]

put-conformance-pack

Description

Creates or updates a conformance pack. A conformance pack is a collection of AWS Config rules that can be easily deployed in an account and a region and across AWS Organization.

This API creates a service linked role AWSServiceRoleForConfigConforms in your account. The service linked role is created only when the role does not exist in your account.

Note

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-conformance-pack
--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>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--conformance-pack-name (string)

Name of the conformance pack you want to create.

--template-s3-uri (string)

Location of file containing the template body (s3://bucketname/prefix ). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

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.

Note

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

--delivery-s3-bucket (string)

AWS Config stores intermediate files while processing conformance pack template.

--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"
  }
  ...
]

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

ConformancePackArn -> (string)

ARN of the conformance pack.