AttachmentsSource - AWS Systems Manager

AttachmentsSource

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.

Contents

Key

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

Type: String

Valid Values: SourceUrl | S3FileUrl | AttachmentReference

Required: No

Name

The name of the document attachment file.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

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

Type: Array of strings

Array Members: Fixed number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: