Skip to content

/AWS1/CL_SSMATTACHMENTSSOURCE

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_key TYPE /AWS1/SSMATTACHMENTSSOURCEKEY /AWS1/SSMATTACHMENTSSOURCEKEY

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

it_values TYPE /AWS1/CL_SSMATTACHMENTSSRCVA00=>TT_ATTACHMENTSSOURCEVALUES TT_ATTACHMENTSSOURCEVALUES

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" ]

iv_name TYPE /AWS1/SSMATTACHMENTIDENTIFIER /AWS1/SSMATTACHMENTIDENTIFIER

The name of the document attachment file.

Queryable Attributes

Key

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

Accessible with the following methods

Method Description
GET_KEY() Getter for KEY, with configurable default
ASK_KEY() Getter for KEY w/ exceptions if field has no value
HAS_KEY() Determine if KEY has a value

Values

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" ]

Accessible with the following methods

Method Description
GET_VALUES() Getter for VALUES, with configurable default
ASK_VALUES() Getter for VALUES w/ exceptions if field has no value
HAS_VALUES() Determine if VALUES has a value

Name

The name of the document attachment file.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ATTACHMENTSSOURCELIST

TYPES TT_ATTACHMENTSSOURCELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMATTACHMENTSSOURCE WITH DEFAULT KEY
.