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
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateDocumentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  content: "DocumentContent", # required
  attachments: [
    {
      key: "SourceUrl", # accepts SourceUrl
      values: ["AttachmentsSourceValue"],
    },
  ],
  name: "DocumentName", # required
  version_name: "DocumentVersionName",
  document_version: "DocumentVersion",
  document_format: "YAML", # accepts YAML, JSON
  target_type: "TargetType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::AttachmentsSource>

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

Returns:

  • (Array<Types::AttachmentsSource>)

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

#contentString

A valid JSON or YAML string.

Returns:

  • (String)

    A valid JSON or YAML string.

#document_formatString

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

Returns:

  • (String)

    Specify the document format for the new document version.

#document_versionString

The version of the document that you want to update.

Returns:

  • (String)

    The version of the document that you want to update.

#nameString

The name of the document that you want to update.

Returns:

  • (String)

    The name of the document that you want to update.

#target_typeString

Specify a new target type for the document.

Returns:

  • (String)

    Specify a new target type for the document.

#version_nameString

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.

Returns:

  • (String)

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