Show / Hide Table of Contents

Class 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.

Inheritance
object
CfnDocument.AttachmentsSourceProperty
Implements
CfnDocument.IAttachmentsSourceProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocument.AttachmentsSourceProperty : CfnDocument.IAttachmentsSourceProperty
Syntax (vb)
Public Class CfnDocument.AttachmentsSourceProperty Implements 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

Constructors

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.

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.

Constructors

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.

public AttachmentsSourceProperty()
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" }
             };

Properties

Key

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

public string? Key { get; set; }
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.

public string? Name { get; set; }
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.

public string[]? Values { get; set; }
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

        Implements

        CfnDocument.IAttachmentsSourceProperty
        Back to top Generated by DocFX