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

Inherits:
Struct
  • Object
show all
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, S3FileUrl, AttachmentReference
      values: ["AttachmentsSourceValue"],
      name: "AttachmentIdentifier",
    },
  ],
  name: "DocumentName", # required
  display_name: "DocumentDisplayName",
  version_name: "DocumentVersionName",
  document_version: "DocumentVersion",
  document_format: "YAML", # accepts YAML, JSON, TEXT
  target_type: "TargetType",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::AttachmentsSource>

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

Returns:


20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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

#contentString

A valid JSON or YAML string.

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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

#display_nameString

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.

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  SENSITIVE = []
  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)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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

#document_versionString

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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

#nameString

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

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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

#target_typeString

Specify a new target type for the document.

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

class UpdateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_version,
  :document_format,
  :target_type)
  SENSITIVE = []
  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 can't be changed.

Returns:

  • (String)

20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
# File 'lib/aws-sdk-ssm/types.rb', line 20716

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