Class: Aws::SSM::Types::AttachmentsSource

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 AttachmentsSource data as a hash:

{
  key: "SourceUrl", # accepts SourceUrl, S3FileUrl, AttachmentReference
  values: ["AttachmentsSourceValue"],
  name: "AttachmentIdentifier",
}

Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The key of a key-value pair that identifies the location of an attachment to a document.

Returns:

  • (String)


956
957
958
959
960
961
962
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 956

class AttachmentsSource < Struct.new(
  :key,
  :values,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the document attachment file.

Returns:

  • (String)


956
957
958
959
960
961
962
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 956

class AttachmentsSource < Struct.new(
  :key,
  :values,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

  • For the key SourceUrl, the value is an S3 bucket location. For example:

    "Values": [ "s3://doc-example-bucket/my-folder" ]

  • For the key S3FileUrl, the value is a file in an S3 bucket. For example:

    "Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]

  • For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

    "Values": [ "MyOtherDocument/3/my-other-file.py" ]

    However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

    "Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]

Returns:

  • (Array<String>)


956
957
958
959
960
961
962
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 956

class AttachmentsSource < Struct.new(
  :key,
  :values,
  :name)
  SENSITIVE = []
  include Aws::Structure
end