aws-cdk-lib.aws_config.CfnConformancePack.TemplateSSMDocumentDetailsProperty

interface TemplateSSMDocumentDetailsProperty

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

This API allows you to create a conformance pack template with an AWS Systems Manager document (SSM document).

To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API . You can also provide the DocumentVersion .

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

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';
const templateSSMDocumentDetailsProperty: config.CfnConformancePack.TemplateSSMDocumentDetailsProperty = {
  documentName: 'documentName',
  documentVersion: 'documentVersion',
};

Properties

NameTypeDescription
documentName?stringThe name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.
documentVersion?stringThe version of the SSM document to use to create a conformance pack.

documentName?

Type: string (optional)

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.

If you use the document name, AWS Config checks only your account and AWS Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.


documentVersion?

Type: string (optional)

The version of the SSM document to use to create a conformance pack.

By default, AWS Config uses the latest version.

This field is optional.