Interface CfnDocument.IAttachmentsSourceProperty

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.

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDocument.IAttachmentsSourceProperty

Syntax (vb)

Public Interface CfnDocument.IAttachmentsSourceProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSM;

             var attachmentsSourceProperty = new AttachmentsSourceProperty {
                 Key = "key",
                 Name = "name",
                 Values = new [] { "values" }
             };

Synopsis

Properties

Key	The key of a key-value pair that identifies the location of an attachment to a document.
Name	The name of the document attachment file.
Values	The value of a key-value pair that identifies the location of an attachment to a document.

Properties

Key

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

string? Key { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key

Name

The name of the document attachment file.

string? Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name

Values

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

string[]? Values { get; }

Property Value

string[]

Remarks

The format for Value depends on the type of key you specify.

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ]

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ]

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values