Package 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:
IEnvironmentAware, IInspectable, ITaggable, IDocumentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:15.589Z") @Stability(Stable) public class CfnDocument extends CfnResource implements IInspectable, IDocumentRef, ITaggable
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 AWS CloudFormation drift detection.

Example: 

 Application application;
 CfnDocument document;
 SourcedConfiguration.Builder.create(this, "MySourcedConfiguration")
         .application(application)
         .location(ConfigurationSource.fromCfnDocument(document))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDocument

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

    • CfnDocument

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

    • CfnDocument

      @Stability(Stable) public CfnDocument(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDocumentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromDocumentName

      @Stability(Stable) @NotNull public static IDocumentRef fromDocumentName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String documentName)
      Creates a new IDocumentRef from a documentName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      documentName - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDocumentRef

      @Stability(Stable) @NotNull public DocumentReference getDocumentRef()
      A reference to a Document resource.
      Specified by:
      getDocumentRef in interface IDocumentRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getContent

      @Stability(Stable) @NotNull public Object getContent()
      The content for the new SSM document in JSON or YAML.

    • setContent

      @Stability(Stable) public void setContent(@NotNull Object value)
      The content for the new SSM document in JSON or YAML.

    • getAttachments

      @Stability(Stable) @Nullable public Object getAttachments()
      A list of key-value pairs that describe attachments to a version of a document.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDocument.AttachmentsSourceProperty>

    • setAttachments

      @Stability(Stable) public void setAttachments(@Nullable IResolvable value)
      A list of key-value pairs that describe attachments to a version of a document.

    • setAttachments

      @Stability(Stable) public void setAttachments(@Nullable List<Object> value)
      A list of key-value pairs that describe attachments to a version of a document.

    • getDocumentFormat

      @Stability(Stable) @Nullable public String getDocumentFormat()
      Specify the document format for the request.

    • setDocumentFormat

      @Stability(Stable) public void setDocumentFormat(@Nullable String value)
      Specify the document format for the request.

    • getDocumentType

      @Stability(Stable) @Nullable public String getDocumentType()
      The type of document to create.

    • setDocumentType

      @Stability(Stable) public void setDocumentType(@Nullable String value)
      The type of document to create.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A name for the SSM document.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A name for the SSM document.

    • getRequires

      @Stability(Stable) @Nullable public Object getRequires()
      A list of SSM documents required by a document.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDocument.DocumentRequiresProperty>

    • setRequires

      @Stability(Stable) public void setRequires(@Nullable IResolvable value)
      A list of SSM documents required by a document.

    • setRequires

      @Stability(Stable) public void setRequires(@Nullable List<Object> value)
      A list of SSM documents required by a document.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      AWS CloudFormation resource tags to apply to the document.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      AWS CloudFormation resource tags to apply to the document.

    • getTargetType

      @Stability(Stable) @Nullable public String getTargetType()
      Specify a target type to define the kinds of resources the document can run on.

    • setTargetType

      @Stability(Stable) public void setTargetType(@Nullable String value)
      Specify a target type to define the kinds of resources the document can run on.

    • getUpdateMethod

      @Stability(Stable) @Nullable public 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.

    • setUpdateMethod

      @Stability(Stable) public void setUpdateMethod(@Nullable String value)
      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.

    • getVersionName

      @Stability(Stable) @Nullable public String getVersionName()
      An optional field specifying the version of the artifact you are creating with the document.

    • setVersionName

      @Stability(Stable) public void setVersionName(@Nullable String value)
      An optional field specifying the version of the artifact you are creating with the document.