Package software.amazon.awscdk.services.ssm

Class CfnDocument.AttachmentsSourceProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnDocument.AttachmentsSourceProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocument.AttachmentsSourceProperty>

Enclosing interface:

CfnDocument.AttachmentsSourceProperty

@Stability(Stable)
public static final class CfnDocument.AttachmentsSourceProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDocument.AttachmentsSourceProperty>

A builder for CfnDocument.AttachmentsSourceProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDocument.AttachmentsSourceProperty	build()	Builds the configured instance.
CfnDocument.AttachmentsSourceProperty.Builder	key(String key)	Sets the value of CfnDocument.AttachmentsSourceProperty.getKey()
CfnDocument.AttachmentsSourceProperty.Builder	name(String name)	Sets the value of CfnDocument.AttachmentsSourceProperty.getName()
CfnDocument.AttachmentsSourceProperty.Builder	values(List<String> values)	Sets the value of CfnDocument.AttachmentsSourceProperty.getValues()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

key

@Stability(Stable)
public CfnDocument.AttachmentsSourceProperty.Builder key(String key)

Sets the value of CfnDocument.AttachmentsSourceProperty.getKey()

Parameters:

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

Returns:

this

name

@Stability(Stable)
public CfnDocument.AttachmentsSourceProperty.Builder name(String name)

Sets the value of CfnDocument.AttachmentsSourceProperty.getName()

Parameters:

name - The name of the document attachment file.

Returns:

this

values

@Stability(Stable)
public CfnDocument.AttachmentsSourceProperty.Builder values(List<String> values)

Sets the value of CfnDocument.AttachmentsSourceProperty.getValues()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDocument.AttachmentsSourceProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDocument.AttachmentsSourceProperty>

Returns:

a new instance of CfnDocument.AttachmentsSourceProperty

Throws:

NullPointerException - if any required attribute was not provided