Package software.amazon.awscdk.services.ssm

Interface CfnDocument.AttachmentsSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocument.AttachmentsSourceProperty.Jsii$Proxy

Enclosing class:

CfnDocument

@Stability(Stable)
public static interface CfnDocument.AttachmentsSourceProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ssm.*;
 AttachmentsSourceProperty attachmentsSourceProperty = AttachmentsSourceProperty.builder()
         .key("key")
         .name("name")
         .values(List.of("values"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDocument.AttachmentsSourceProperty.Builder	A builder for CfnDocument.AttachmentsSourceProperty
static final class	CfnDocument.AttachmentsSourceProperty.Jsii$Proxy	An implementation for CfnDocument.AttachmentsSourceProperty

Method Summary

Modifier and Type	Method	Description
static CfnDocument.AttachmentsSourceProperty.Builder	builder()
default String	getKey()	The key of a key-value pair that identifies the location of an attachment to a document.
default String	getName()	The name of the document attachment file.
default List<String>	getValues()	The value of a key-value pair that identifies the location of an attachment to a document.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKey

@Stability(Stable)
@Nullable
default String getKey()

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the document attachment file.

getValues

@Stability(Stable)
@Nullable
default List<String> getValues()

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

builder

@Stability(Stable)
static CfnDocument.AttachmentsSourceProperty.Builder builder()

Returns:

a CfnDocument.AttachmentsSourceProperty.Builder of CfnDocument.AttachmentsSourceProperty