Class: Aws::SSM::Types::UpdateDocumentRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::UpdateDocumentRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass UpdateDocumentRequest data as a 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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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

  The 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.

Returns:

• (Array<Types::AttachmentsSource>)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#content ⇒ String

A valid JSON or YAML string.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#document_format ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#document_version ⇒ String

The version of the document that you want to update.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#name ⇒ String

The name of the document that you want to update.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#target_type ⇒ String

Specify a new target type for the document.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13102

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  include Aws::Structure
end