@aws-sdk/client-ssm

UpdateDocumentCommandInput Interface

The input for UpdateDocumentCommand.

Members

Name
Type
Details
Content Requiredstring | undefined

A valid JSON or YAML string.

Name Requiredstring | undefined

The name of the SSM document that you want to update.

Attachments AttachmentsSource[] | undefined

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

DisplayName string | undefined

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

DocumentFormat DocumentFormat | undefined

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

DocumentVersion string | undefined

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

TargetType string | undefined

Specify a new target type for the document.

VersionName string | undefined

An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Full Signature

export interface UpdateDocumentCommandInput extends UpdateDocumentRequest