software.amazon.awscdk.services.ssm

Class CfnDocument

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssm.CfnDocument

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:48.118Z")
 @Stability(value=Stable)
public class CfnDocument
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::Document`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDocument.AttachmentsSourceProperty
static class	CfnDocument.Builder A fluent builder for CfnDocument.
static interface	CfnDocument.DocumentRequiresProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDocument(software.constructs.Construct scope, String id, CfnDocumentProps props) Create a new `AWS::SSM::Document`.
protected	CfnDocument(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocument(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAttachments() `AWS::SSM::Document.Attachments`.
protected Map<String,Object>	getCfnProperties()
Object	getContent() `AWS::SSM::Document.Content`.
String	getDocumentFormat() `AWS::SSM::Document.DocumentFormat`.
String	getDocumentType() `AWS::SSM::Document.DocumentType`.
String	getName() `AWS::SSM::Document.Name`.
Object	getRequires() `AWS::SSM::Document.Requires`.
TagManager	getTags() `AWS::SSM::Document.Tags`.
String	getTargetType() `AWS::SSM::Document.TargetType`.
String	getVersionName() `AWS::SSM::Document.VersionName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttachments(IResolvable value) `AWS::SSM::Document.Attachments`.
void	setAttachments(List<Object> value) `AWS::SSM::Document.Attachments`.
void	setContent(Object value) `AWS::SSM::Document.Content`.
void	setDocumentFormat(String value) `AWS::SSM::Document.DocumentFormat`.
void	setDocumentType(String value) `AWS::SSM::Document.DocumentType`.
void	setName(String value) `AWS::SSM::Document.Name`.
void	setRequires(IResolvable value) `AWS::SSM::Document.Requires`.
void	setRequires(List<Object> value) `AWS::SSM::Document.Requires`.
void	setTargetType(String value) `AWS::SSM::Document.TargetType`.
void	setVersionName(String value) `AWS::SSM::Document.VersionName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDocument

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

CfnDocument

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

CfnDocument

@Stability(value=Stable)
public CfnDocument(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnDocumentProps props)

Create a new `AWS::SSM::Document`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::SSM::Document.Tags`.

getContent

@Stability(value=Stable)
 @NotNull
public Object getContent()

`AWS::SSM::Document.Content`.

setContent

@Stability(value=Stable)
public void setContent(@NotNull
                                                Object value)

`AWS::SSM::Document.Content`.

getAttachments

@Stability(value=Stable)
 @Nullable
public Object getAttachments()

`AWS::SSM::Document.Attachments`.

setAttachments

@Stability(value=Stable)
public void setAttachments(@Nullable
                                                    IResolvable value)

`AWS::SSM::Document.Attachments`.

setAttachments

@Stability(value=Stable)
public void setAttachments(@Nullable
                                                    List<Object> value)

`AWS::SSM::Document.Attachments`.

getDocumentFormat

@Stability(value=Stable)
 @Nullable
public String getDocumentFormat()

`AWS::SSM::Document.DocumentFormat`.

setDocumentFormat

@Stability(value=Stable)
public void setDocumentFormat(@Nullable
                                                       String value)

`AWS::SSM::Document.DocumentFormat`.

getDocumentType

@Stability(value=Stable)
 @Nullable
public String getDocumentType()

`AWS::SSM::Document.DocumentType`.

setDocumentType

@Stability(value=Stable)
public void setDocumentType(@Nullable
                                                     String value)

`AWS::SSM::Document.DocumentType`.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

`AWS::SSM::Document.Name`.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

`AWS::SSM::Document.Name`.

getRequires

@Stability(value=Stable)
 @Nullable
public Object getRequires()

`AWS::SSM::Document.Requires`.

setRequires

@Stability(value=Stable)
public void setRequires(@Nullable
                                                 IResolvable value)

`AWS::SSM::Document.Requires`.

setRequires

@Stability(value=Stable)
public void setRequires(@Nullable
                                                 List<Object> value)

`AWS::SSM::Document.Requires`.

getTargetType

@Stability(value=Stable)
 @Nullable
public String getTargetType()

`AWS::SSM::Document.TargetType`.

setTargetType

@Stability(value=Stable)
public void setTargetType(@Nullable
                                                   String value)

`AWS::SSM::Document.TargetType`.

getVersionName

@Stability(value=Stable)
 @Nullable
public String getVersionName()

`AWS::SSM::Document.VersionName`.

setVersionName

@Stability(value=Stable)
public void setVersionName(@Nullable
                                                    String value)

`AWS::SSM::Document.VersionName`.