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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.742Z")
@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();
 

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

Method Details

getContent

@Stability(Stable)
@NotNull
Object getContent()

The content for the new SSM document in JSON or YAML.

For more information about the schemas for SSM document content, see SSM document schema features and examples in the AWS Systems Manager User Guide .

This parameter also supports String data types.

getAttachments

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

A list of key-value pairs that describe attachments to a version of a document.

getDocumentFormat

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

Specify the document format for the request.

JSON is the default format.

getDocumentType

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

The type of document to create.

Allowed Values : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

getName

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

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

• aws
• amazon
• amzn

getRequires

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

A list of SSM documents required by a document.

This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .

getTags

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

AWS CloudFormation resource tags to apply to the document.

Use tags to help you identify and categorize resources.

getTargetType

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

Specify a target type to define the kinds of resources the document can run on.

For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide .

getUpdateMethod

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

Replace is the default method. If you specify NewVersion for the UpdateMethod parameter, and the Name of the document does not match an existing resource, a new document is created. When you specify NewVersion , the default version of the document is changed to the newly created version.

getVersionName

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

An optional field specifying the version of the artifact you are creating with the document.

For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

builder

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

Returns:

a CfnDocumentProps.Builder of CfnDocumentProps