aws-cdk-lib.aws_config.CfnConformancePackProps

interface CfnConformancePackProps

LanguageType name
.NETAmazon.CDK.AWS.Config.CfnConformancePackProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CfnConformancePackProps
Javasoftware.amazon.awscdk.services.config.CfnConformancePackProps
Pythonaws_cdk.aws_config.CfnConformancePackProps
TypeScript aws-cdk-lib » aws_config » CfnConformancePackProps

Properties for defining a CfnConformancePack.

Example

// 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',
  templateBody: 'templateBody',
  templateS3Uri: 'templateS3Uri',
  templateSsmDocumentDetails: templateSsmDocumentDetails,
};

Properties

NameTypeDescription
conformancePackNamestringName of the conformance pack you want to create.
conformancePackInputParameters?IResolvable | IResolvable | ConformancePackInputParameterProperty[]A list of ConformancePackInputParameter objects.
deliveryS3Bucket?stringThe name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
deliveryS3KeyPrefix?stringThe prefix for the Amazon S3 bucket.
templateBody?stringA string containing full conformance pack template body.
templateS3Uri?stringLocation of file containing the template body (s3://bucketname/prefix).
templateSsmDocumentDetails?anyAWS::Config::ConformancePack.TemplateSSMDocumentDetails.

conformancePackName

Type: string

Name of the conformance pack you want to create.


conformancePackInputParameters?

Type: IResolvable | IResolvable | ConformancePackInputParameterProperty[] (optional)

A list of ConformancePackInputParameter objects.


deliveryS3Bucket?

Type: string (optional)

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


deliveryS3KeyPrefix?

Type: string (optional)

The prefix for the Amazon S3 bucket.


templateBody?

Type: string (optional)

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.

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


templateS3Uri?

Type: string (optional)

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.


templateSsmDocumentDetails?

Type: any (optional)

AWS::Config::ConformancePack.TemplateSSMDocumentDetails.