Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnDocumentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnDocumentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.676Z")
@Stability(Stable)
public class CfnDocumentPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::SSM::Document resource creates a Systems Manager (SSM) document in AWS Systems Manager .

This document defines the actions that Systems Manager performs on your AWS resources.

This resource does not support CloudFormation drift detection.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 import software.amazon.awscdk.*;
 Object content;
 IMergeStrategy mergeStrategy;
 CfnDocumentPropsMixin cfnDocumentPropsMixin = CfnDocumentPropsMixin.Builder.create(CfnDocumentMixinProps.builder()
         .attachments(List.of(AttachmentsSourceProperty.builder()
                 .key("key")
                 .name("name")
                 .values(List.of("values"))
                 .build()))
         .content(content)
         .documentFormat("documentFormat")
         .documentType("documentType")
         .name("name")
         .requires(List.of(DocumentRequiresProperty.builder()
                 .name("name")
                 .version("version")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetType("targetType")
         .updateMethod("updateMethod")
         .versionName("versionName")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDocumentPropsMixin.AttachmentsSourceProperty	Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.
static final class	CfnDocumentPropsMixin.Builder	A fluent builder for CfnDocumentPropsMixin.
static interface	CfnDocumentPropsMixin.DocumentRequiresProperty	An SSM document required by the current document.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDocumentPropsMixin(CfnDocumentMixinProps props)	Create a mixin to apply properties to AWS::SSM::Document.
	CfnDocumentPropsMixin(CfnDocumentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SSM::Document.
protected	CfnDocumentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocumentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDocumentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDocumentPropsMixin

protected CfnDocumentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDocumentPropsMixin

protected CfnDocumentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDocumentPropsMixin

@Stability(Stable)
public CfnDocumentPropsMixin(@NotNull
 CfnDocumentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SSM::Document.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDocumentPropsMixin

@Stability(Stable)
public CfnDocumentPropsMixin(@NotNull
 CfnDocumentMixinProps props)

Create a mixin to apply properties to AWS::SSM::Document.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDocumentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()