AWS::SSM::Document AttachmentsSource - AWS CloudFormation

AWS::SSM::Document 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Key" : String, "Name" : String, "Values" : [ String, ... ] }

YAML

Key: String Name: String Values: - String

Properties

Key

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

Required: No

Type: String

Allowed values: AttachmentReference | S3FileUrl | SourceUrl

Update requires: No interruption

Name

The name of the document attachment file.

Required: No

Type: String

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

Update requires: No interruption

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

Required: No

Type: List of String

Maximum: 1

Update requires: No interruption