software.amazon.awscdk.services.ssm

Interface CfnDocumentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:08.015Z")
 @Stability(value=Stable)
public interface CfnDocumentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::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.ssm.*;
 Object content;
 CfnDocumentProps cfnDocumentProps = CfnDocumentProps.builder()
         .content(content)
         // the properties below are optional
         .attachments(List.of(AttachmentsSourceProperty.builder()
                 .key("key")
                 .name("name")
                 .values(List.of("values"))
                 .build()))
         .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")
         .versionName("versionName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDocumentProps.Builder	builder()
default Object	getAttachments() `AWS::SSM::Document.Attachments`.
Object	getContent() `AWS::SSM::Document.Content`.
default String	getDocumentFormat() `AWS::SSM::Document.DocumentFormat`.
default String	getDocumentType() `AWS::SSM::Document.DocumentType`.
default String	getName() `AWS::SSM::Document.Name`.
default Object	getRequires() `AWS::SSM::Document.Requires`.
default List<CfnTag>	getTags() `AWS::SSM::Document.Tags`.
default String	getTargetType() `AWS::SSM::Document.TargetType`.
default String	getVersionName() `AWS::SSM::Document.VersionName`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttachments

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

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

getContent

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

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

getDocumentFormat

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

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

getDocumentType

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

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

getName

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

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

getRequires

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getTargetType

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

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

getVersionName

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

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

builder

@Stability(value=Stable)
static CfnDocumentProps.Builder builder()

Returns:

a CfnDocumentProps.Builder of CfnDocumentProps