Package 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.116.0 (build 0eddcff)", date="2025-10-29T11:15:49.174Z") @Stability(Stable) public interface CfnDocumentProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDocument.

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")
         .updateMethod("updateMethod")
         .versionName("versionName")
         .build();

See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnDocumentProps.Builder
    builder()
     
    default Object
    getAttachments()
    A list of key-value pairs that describe attachments to a version of a document.
    Object
    getContent()
    The content for the new SSM document in JSON or YAML.
    default String
    getDocumentFormat()
    Specify the document format for the request.
    default String
    getDocumentType()
    The type of document to create.
    default String
    getName()
    A name for the SSM document.
    default Object
    getRequires()
    A list of SSM documents required by a document.
    default List<CfnTag>
    getTags()
    AWS CloudFormation resource tags to apply to the document.
    default String
    getTargetType()
    Specify a target type to define the kinds of resources the document can run on.
    default String
    getUpdateMethod()
    If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.
    default String
    getVersionName()
    An optional field specifying the version of the artifact you are creating with the document.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson