Package software.amazon.awscdk.services.config

Interface CfnConformancePack.TemplateSSMDocumentDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConformancePack.TemplateSSMDocumentDetailsProperty.Jsii$Proxy

Enclosing class:

CfnConformancePack

@Stability(Stable)
public static interface CfnConformancePack.TemplateSSMDocumentDetailsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.config.*;
 TemplateSSMDocumentDetailsProperty templateSSMDocumentDetailsProperty = TemplateSSMDocumentDetailsProperty.builder()
         .documentName("documentName")
         .documentVersion("documentVersion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConformancePack.TemplateSSMDocumentDetailsProperty.Builder	A builder for CfnConformancePack.TemplateSSMDocumentDetailsProperty
static final class	CfnConformancePack.TemplateSSMDocumentDetailsProperty.Jsii$Proxy	An implementation for CfnConformancePack.TemplateSSMDocumentDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnConformancePack.TemplateSSMDocumentDetailsProperty.Builder	builder()
default String	getDocumentName()	The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.
default String	getDocumentVersion()	The version of the SSM document to use to create a conformance pack.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentName

@Stability(Stable)
@Nullable
default String getDocumentName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentname

getDocumentVersion

@Stability(Stable)
@Nullable
default String getDocumentVersion()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentversion

builder

@Stability(Stable)
static CfnConformancePack.TemplateSSMDocumentDetailsProperty.Builder builder()

Returns:

a CfnConformancePack.TemplateSSMDocumentDetailsProperty.Builder of CfnConformancePack.TemplateSSMDocumentDetailsProperty