software.amazon.awscdk.services.transfer

Class CfnConnector.Builder

java.lang.Object

software.amazon.awscdk.services.transfer.CfnConnector.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConnector>

Enclosing class:

CfnConnector

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

A fluent builder for CfnConnector.

Method Summary

Modifier and Type	Method and Description
CfnConnector.Builder	accessRole(String accessRole) With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .
CfnConnector.Builder	as2Config(Object as2Config) A structure that contains the parameters for a connector object.
CfnConnector	build()
static CfnConnector.Builder	create(Construct scope, String id)
CfnConnector.Builder	loggingRole(String 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.
CfnConnector.Builder	tags(List<? extends CfnTag> tags) Key-value pairs that can be used to group and search for connectors.
CfnConnector.Builder	url(String url) The URL of the partner's AS2 endpoint.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnConnector.Builder create(Construct scope,
                                                                   String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnConnector.As2ConfigProperty.Builder.

accessRole

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

With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths` .

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 .

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.

Returns:

this

as2Config

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

A structure that contains the parameters for a connector object.

Parameters:

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

Returns:

this

url

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

The URL of the partner's AS2 endpoint.

Parameters:

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

Returns:

this

loggingRole

@Stability(value=Stable)
public CfnConnector.Builder loggingRole(String 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.

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. This parameter is required.

Returns:

this

tags

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

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

Parameters:

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

Returns:

this

build

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

Specified by:

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