software.amazon.awscdk.services.transfer

Class CfnConnectorProps.Builder

java.lang.Object

software.amazon.awscdk.services.transfer.CfnConnectorProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConnectorProps>

Enclosing interface:

CfnConnectorProps

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

A builder for CfnConnectorProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnConnectorProps.Builder	accessRole(String accessRole) Sets the value of CfnConnectorProps.getAccessRole()
CfnConnectorProps.Builder	as2Config(Object as2Config) Sets the value of CfnConnectorProps.getAs2Config()
CfnConnectorProps	build() Builds the configured instance.
CfnConnectorProps.Builder	loggingRole(String loggingRole) Sets the value of CfnConnectorProps.getLoggingRole()
CfnConnectorProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnConnectorProps.getTags()
CfnConnectorProps.Builder	url(String url) Sets the value of CfnConnectorProps.getUrl()

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 CfnConnectorProps.Builder accessRole(String accessRole)

Sets the value of CfnConnectorProps.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

as2Config

@Stability(value=Stable)
public CfnConnectorProps.Builder as2Config(Object as2Config)

Sets the value of CfnConnectorProps.getAs2Config()

Parameters:

as2Config - A structure that contains the parameters for a connector object. This parameter is required.

Returns:

this

url

@Stability(value=Stable)
public CfnConnectorProps.Builder url(String url)

Sets the value of CfnConnectorProps.getUrl()

Parameters:

url - The URL of the partner's AS2 endpoint. This parameter is required.

Returns:

this

loggingRole

@Stability(value=Stable)
public CfnConnectorProps.Builder loggingRole(String loggingRole)

Sets the value of CfnConnectorProps.getLoggingRole()

Parameters:

loggingRole - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

Returns:

this

tags

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

Sets the value of CfnConnectorProps.getTags()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnConnectorProps

Throws:

NullPointerException - if any required attribute was not provided