You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::UpdateDocumentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::UpdateDocumentRequest
- Defined in:
- (unknown)
Overview
When passing UpdateDocumentRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
content: "DocumentContent", # required
attachments: [
{
key: "SourceUrl", # accepts SourceUrl, S3FileUrl, AttachmentReference
values: ["AttachmentsSourceValue"],
name: "AttachmentIdentifier",
},
],
name: "DocumentName", # required
version_name: "DocumentVersionName",
document_version: "DocumentVersion",
document_format: "YAML", # accepts YAML, JSON, TEXT
target_type: "TargetType",
}
Instance Attribute Summary collapse
-
#attachments ⇒ Array<Types::AttachmentsSource>
A list of key and value pairs that describe attachments to a version of a document.
-
#content ⇒ String
A valid JSON or YAML string.
-
#document_format ⇒ String
Specify the document format for the new document version.
-
#document_version ⇒ String
(Required) The latest version of the document that you want to update.
-
#name ⇒ String
The name of the document that you want to update.
-
#target_type ⇒ String
Specify a new target type for the document.
-
#version_name ⇒ String
An optional field specifying the version of the artifact you are updating with the document.
Instance Attribute Details
#attachments ⇒ Array<Types::AttachmentsSource>
A list of key and value pairs that describe attachments to a version of a document.
#content ⇒ String
A valid JSON or YAML string.
#document_format ⇒ String
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
Possible values:
- YAML
- JSON
- TEXT
#document_version ⇒ String
(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.
#name ⇒ String
The name of the document that you want to update.
#target_type ⇒ String
Specify a new target type for the document.
#version_name ⇒ String
An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.