DocumentArgs

data class DocumentArgs(val attachments: Output<List<DocumentAttachmentsSourceArgs>>? = null, val content: Output<Any>? = null, val documentFormat: Output<DocumentFormat>? = null, val documentType: Output<DocumentType>? = null, val name: Output<String>? = null, val requires: Output<List<DocumentRequiresArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val targetType: Output<String>? = null, val updateMethod: Output<DocumentUpdateMethod>? = null, val versionName: Output<String>? = null) : ConvertibleToJava<DocumentArgs>

The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.

Example Usage

Example

No Java example available.

Example

No Java example available.

Example

No Java example available.

Example

No Java example available.

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(attachments: Output<List<DocumentAttachmentsSourceArgs>>? = null, content: Output<Any>? = null, documentFormat: Output<DocumentFormat>? = null, documentType: Output<DocumentType>? = null, name: Output<String>? = null, requires: Output<List<DocumentRequiresArgs>>? = null, tags: Output<List<TagArgs>>? = null, targetType: Output<String>? = null, updateMethod: Output<DocumentUpdateMethod>? = null, versionName: Output<String>? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard
val content: Output<Any>? = null

The content for the Systems Manager document in JSON, YAML or String format. Search the CloudFormation User Guide for AWS::SSM::Document for more information about the expected schema for this property.

Link copied to clipboard
val documentFormat: Output<DocumentFormat>? = null

Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Link copied to clipboard
val documentType: Output<DocumentType>? = null

The type of document to create.

Link copied to clipboard
val name: Output<String>? = null

A name for the Systems Manager document.

Link copied to clipboard
val requires: Output<List<DocumentRequiresArgs>>? = null

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.

Link copied to clipboard
val targetType: Output<String>? = null

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

Link copied to clipboard
val updateMethod: Output<DocumentUpdateMethod>? = null

Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.

Link copied to clipboard
val versionName: Output<String>? = null

An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.

Functions

Link copied to clipboard
open override fun toJava(): DocumentArgs