You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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",
}

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:



13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

#contentString

A valid JSON or YAML string.

Returns:

  • (String)


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

#document_formatString

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

Returns:

  • (String)


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

#document_versionString

The version of the document that you want to update.

Returns:

  • (String)


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

#nameString

The name of the document that you want to update.

Returns:

  • (String)


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

#target_typeString

Specify a new target type for the document.

Returns:

  • (String)


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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

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


13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 13440

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