Skip to content
v2.275.0

CfnConformancePackProps Struct ​

Properties for defining a CfnConformancePack.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_config as config } from 'aws-cdk-lib';

declare const templateSsmDocumentDetails: any;
const cfnConformancePackProps: config.CfnConformancePackProps = {
  conformancePackName: 'conformancePackName',

  // the properties below are optional
  conformancePackInputParameters: [{
    parameterName: 'parameterName',
    parameterValue: 'parameterValue',
  }],
  deliveryS3Bucket: 'deliveryS3Bucket',
  deliveryS3KeyPrefix: 'deliveryS3KeyPrefix',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateBody: 'templateBody',
  templateS3Uri: 'templateS3Uri',
  templateSsmDocumentDetails: templateSsmDocumentDetails,
};

Properties ​

conformancePackInputParametersoptionalIResolvable | IResolvable | CfnConformancePack.ConformancePackInputParameterProperty[]conformance_pack_input_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConformancePackInputParameterProperty]]]conformancePackInputParametersoptionalIResolvableConformancePackInputParametersoptionalIResolvableConformancePackInputParametersoptionalinterface{}#
A list of ConformancePackInputParameter objects.
conformancePackNamestringconformance_pack_namestrconformancePackNameStringConformancePackNamestringConformancePackName*stringrequired#
Name of the conformance pack you want to create.
deliveryS3Bucketoptionalstring | IBucketRefdelivery_s3_bucketoptionaltyping.Union[str, IBucketRef]deliveryS3BucketoptionalStringDeliveryS3BucketoptionalstringDeliveryS3Bucketoptionalinterface{}#
The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
deliveryS3KeyPrefixoptionalstringdelivery_s3_key_prefixoptionalstrdeliveryS3KeyPrefixoptionalStringDeliveryS3KeyPrefixoptionalstringDeliveryS3KeyPrefixoptional*string#
The prefix for the Amazon S3 bucket.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags for the conformance pack.
templateBodyoptionalstringtemplate_bodyoptionalstrtemplateBodyoptionalStringTemplateBodyoptionalstringTemplateBodyoptional*string#
A string containing full conformance pack template body.
notes

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

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

You must have access to read Amazon S3 bucket.

templateSsmDocumentDetailsoptionalanytemplate_ssm_document_detailsoptionalAnytemplateSsmDocumentDetailsoptionalObjectTemplateSsmDocumentDetailsoptionalobjectTemplateSsmDocumentDetailsoptionalinterface{}#
An object that contains the name or Amazon Resource Name (ARN) of the AWS Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.