software.amazon.awscdk.services.transfer

Class CfnAgreementProps.Builder

java.lang.Object

software.amazon.awscdk.services.transfer.CfnAgreementProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgreementProps>

Enclosing interface:

CfnAgreementProps

@Stability(value=Stable)
public static final class CfnAgreementProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgreementProps>

A builder for CfnAgreementProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnAgreementProps.Builder	accessRole(String accessRole) Sets the value of CfnAgreementProps.getAccessRole()
CfnAgreementProps.Builder	baseDirectory(String baseDirectory) Sets the value of CfnAgreementProps.getBaseDirectory()
CfnAgreementProps	build() Builds the configured instance.
CfnAgreementProps.Builder	description(String description) Sets the value of CfnAgreementProps.getDescription()
CfnAgreementProps.Builder	localProfileId(String localProfileId) Sets the value of CfnAgreementProps.getLocalProfileId()
CfnAgreementProps.Builder	partnerProfileId(String partnerProfileId) Sets the value of CfnAgreementProps.getPartnerProfileId()
CfnAgreementProps.Builder	serverId(String serverId) Sets the value of CfnAgreementProps.getServerId()
CfnAgreementProps.Builder	status(String status) Sets the value of CfnAgreementProps.getStatus()
CfnAgreementProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnAgreementProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

accessRole

@Stability(value=Stable)
public CfnAgreementProps.Builder accessRole(String accessRole)

Sets the value of CfnAgreementProps.getAccessRole()

Parameters:

accessRole - With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` . This parameter is required. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt , parent directory is /bucket/dir/ ) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer .

Returns:

this

baseDirectory

@Stability(value=Stable)
public CfnAgreementProps.Builder baseDirectory(String baseDirectory)

Sets the value of CfnAgreementProps.getBaseDirectory()

Parameters:

baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol. This parameter is required.

Returns:

this

localProfileId

@Stability(value=Stable)
public CfnAgreementProps.Builder localProfileId(String localProfileId)

Sets the value of CfnAgreementProps.getLocalProfileId()

Parameters:

localProfileId - A unique identifier for the AS2 local profile. This parameter is required.

Returns:

this

partnerProfileId

@Stability(value=Stable)
public CfnAgreementProps.Builder partnerProfileId(String partnerProfileId)

Sets the value of CfnAgreementProps.getPartnerProfileId()

Parameters:

partnerProfileId - A unique identifier for the partner profile used in the agreement. This parameter is required.

Returns:

this

serverId

@Stability(value=Stable)
public CfnAgreementProps.Builder serverId(String serverId)

Sets the value of CfnAgreementProps.getServerId()

Parameters:

serverId - A system-assigned unique identifier for a server instance. This parameter is required. This identifier indicates the specific server that the agreement uses.

Returns:

this

description

@Stability(value=Stable)
public CfnAgreementProps.Builder description(String description)

Sets the value of CfnAgreementProps.getDescription()

Parameters:

description - The name or short description that's used to identify the agreement.

Returns:

this

status

@Stability(value=Stable)
public CfnAgreementProps.Builder status(String status)

Sets the value of CfnAgreementProps.getStatus()

Parameters:

status - The current status of the agreement, either `ACTIVE` or `INACTIVE` .

Returns:

this

tags

@Stability(value=Stable)
public CfnAgreementProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnAgreementProps.getTags()

Parameters:

tags - Key-value pairs that can be used to group and search for agreements.

Returns:

this

build

@Stability(value=Stable)
public CfnAgreementProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAgreementProps>

Returns:

a new instance of CfnAgreementProps

Throws:

NullPointerException - if any required attribute was not provided