aws-cdk-lib.aws_ssm.CfnDocument.AttachmentsSourceProperty

interface AttachmentsSourceProperty

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnDocument.AttachmentsSourceProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnDocument_AttachmentsSourceProperty
Javasoftware.amazon.awscdk.services.ssm.CfnDocument.AttachmentsSourceProperty
Pythonaws_cdk.aws_ssm.CfnDocument.AttachmentsSourceProperty
TypeScript aws-cdk-lib » aws_ssm » CfnDocument » AttachmentsSourceProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const attachmentsSourceProperty: ssm.CfnDocument.AttachmentsSourceProperty = {
  key: 'key',
  name: 'name',
  values: ['values'],
};

Properties

NameTypeDescription
key?stringThe key of a key-value pair that identifies the location of an attachment to a document.
name?stringThe name of the document attachment file.
values?string[]The value of a key-value pair that identifies the location of an attachment to a document.

key?

Type: string (optional)

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


name?

Type: string (optional)

The name of the document attachment file.


values?

Type: string[] (optional)

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