Skip to content

PutConformancePackRequest

Source code in docs_src/capo_config_service/types/put_conformance_pack_request.py
class PutConformancePackRequest(TypedDict, closed=True):
    conformance_pack_name: (
        "capo_config_service.types.conformance_pack_name.ConformancePackName"
    )
    """<p>The unique name of the conformance pack you want to deploy.</p>"""
    template_s3_uri: NotRequired[
        "capo_config_service.types.template_s3_uri.TemplateS3Uri"
    ]
    """<p>The location of the file containing the template body (<code>s3://bucketname/prefix</code>). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack. </p> <note> <p>You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html">archived storage class</a> if this parameter is passed.</p> </note>"""
    template_body: NotRequired["capo_config_service.types.template_body.TemplateBody"]
    """<p>A string that contains the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <note> <p>You can use a YAML template with two resource types: Config rule (<code>AWS::Config::ConfigRule</code>) and remediation action (<code>AWS::Config::RemediationConfiguration</code>).</p> </note>"""
    delivery_s3_bucket: NotRequired[
        "capo_config_service.types.delivery_s3_bucket.DeliveryS3Bucket"
    ]
    """<p>The name of the Amazon S3 bucket where Config stores conformance pack templates.</p> <note> <p>This field is optional.</p> </note>"""
    delivery_s3_key_prefix: NotRequired[
        "capo_config_service.types.delivery_s3_key_prefix.DeliveryS3KeyPrefix"
    ]
    """<p>The prefix for the Amazon S3 bucket. </p> <note> <p>This field is optional.</p> </note>"""
    conformance_pack_input_parameters: NotRequired[
        "capo_config_service.types.conformance_pack_input_parameters.ConformancePackInputParameters"
    ]
    """<p>A list of <code>ConformancePackInputParameter</code> objects.</p>"""
    template_ssm_document_details: NotRequired[
        "capo_config_service.types.template_ssm_document_details.TemplateSSMDocumentDetails"
    ]
    """<p>An object of type <code>TemplateSSMDocumentDetails</code>, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.</p>"""
    tags: NotRequired["capo_config_service.types.tags_list.TagsList"]
    """<p>The tags for the conformance pack. Each tag consists of a key and an optional value, both of which you define.</p>"""

conformance_pack_input_parameters instance-attribute

conformance_pack_input_parameters: NotRequired[ConformancePackInputParameters]

A list of ConformancePackInputParameter objects.

conformance_pack_name instance-attribute

conformance_pack_name: ConformancePackName

The unique name of the conformance pack you want to deploy.

delivery_s3_bucket instance-attribute

delivery_s3_bucket: NotRequired[DeliveryS3Bucket]

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

delivery_s3_key_prefix instance-attribute

delivery_s3_key_prefix: NotRequired[DeliveryS3KeyPrefix]

The prefix for the Amazon S3 bucket.

This field is optional.

tags instance-attribute

tags: NotRequired[TagsList]

The tags for the conformance pack. Each tag consists of a key and an optional value, both of which you define.

template_body instance-attribute

template_body: NotRequired[TemplateBody]

A string that contains the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

template_s3_uri instance-attribute

template_s3_uri: NotRequired[TemplateS3Uri]

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

You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

template_ssm_document_details instance-attribute

template_ssm_document_details: NotRequired[TemplateSSMDocumentDetails]

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.