class Amazonite::Ssm::AttachmentsSource

Overview

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.

Included Modules

Defined in:

ssm/attachments_source.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(key : AttachmentsSourceKey | Nil = nil, values : Array(String) | Nil = nil, name : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def key : AttachmentsSourceKey | Nil #

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


[View source]
def key=(key : AttachmentsSourceKey | Nil) #

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


[View source]
def name : String | Nil #

The name of the document attachment file.


[View source]
def name=(name : String | Nil) #

The name of the document attachment file.


[View source]
def validate! : Nil #

[View source]
def values : Array(String) | Nil #

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://amzn-s3-demo-bucket/my-prefix" ]

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

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/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" ]


[View source]
def values=(values : Array(String) | Nil) #

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://amzn-s3-demo-bucket/my-prefix" ]

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

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/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" ]


[View source]