interface CfnConformancePackProps

Language	Type name
.NET	`Amazon.CDK.AWS.Config.CfnConformancePackProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CfnConformancePackProps`
Java	`software.amazon.awscdk.services.config.CfnConformancePackProps`
Python	`aws_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

Name	Type	Description
conformancePackName	`string`	Name of the conformance pack you want to create.
conformancePackInputParameters?	`IResolvable` `\|` `IResolvable` `\|` `ConformancePackInputParameterProperty[]`	A list of ConformancePackInputParameter objects.
deliveryS3Bucket?	`string`	The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
deliveryS3KeyPrefix?	`string`	The prefix for the Amazon S3 bucket.
templateBody?	`string`	A string containing full conformance pack template body.
templateS3Uri?	`string`	Location of file containing the template body (s3://bucketname/prefix).
templateSsmDocumentDetails?	`any`	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.

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)

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.