Package 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(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	Description
CfnConnector.Builder	accessRole(String accessRole)	Connectors are used to send files using either the AS2 or SFTP protocol.
CfnConnector.Builder	as2Config(Object as2Config)	A structure that contains the parameters for an AS2 connector object.
CfnConnector	build()
static CfnConnector.Builder	create(software.constructs.Construct scope, String id)
CfnConnector.Builder	egressConfig(IResolvable egressConfig)	Current egress configuration of the connector, showing how traffic is routed to the SFTP server.
CfnConnector.Builder	egressConfig(CfnConnector.ConnectorEgressConfigProperty egressConfig)	Current egress configuration of the connector, showing how traffic is routed to the SFTP server.
CfnConnector.Builder	egressType(String egressType)	Type of egress configuration for the connector.
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	securityPolicyName(String securityPolicyName)	The text name of the security policy for the specified connector.
CfnConnector.Builder	sftpConfig(IResolvable sftpConfig)	A structure that contains the parameters for an SFTP connector object.
CfnConnector.Builder	sftpConfig(CfnConnector.SftpConfigProperty sftpConfig)	A structure that contains the parameters for an SFTP connector object.
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 or SFTP endpoint.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnConnector.Builder.

accessRole

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

Connectors are used to send files using either the AS2 or SFTP protocol.

For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.

For AS2 connectors

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 .

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager .

Parameters:

accessRole - Connectors are used to send files using either the AS2 or SFTP protocol. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-accessrole

as2Config

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

A structure that contains the parameters for an AS2 connector object.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-as2config

egressConfig

@Stability(Stable)
public CfnConnector.Builder egressConfig(IResolvable egressConfig)

Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

Contains VPC Lattice settings when using VPC_LATTICE egress type.

When using the VPC_LATTICE egress type, AWS Transfer Family uses a managed Service Network to simplify the resource sharing process.

Parameters:

egressConfig - Current egress configuration of the connector, showing how traffic is routed to the SFTP server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-egressconfig

egressConfig

@Stability(Stable)
public CfnConnector.Builder egressConfig(CfnConnector.ConnectorEgressConfigProperty egressConfig)

Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

Contains VPC Lattice settings when using VPC_LATTICE egress type.

When using the VPC_LATTICE egress type, AWS Transfer Family uses a managed Service Network to simplify the resource sharing process.

Parameters:

egressConfig - Current egress configuration of the connector, showing how traffic is routed to the SFTP server. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-egressconfig

egressType

@Stability(Stable)
public CfnConnector.Builder egressType(String egressType)

Type of egress configuration for the connector.

SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.

Parameters:

egressType - Type of egress configuration for the connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-egresstype

loggingRole

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-loggingrole

securityPolicyName

@Stability(Stable)
public CfnConnector.Builder securityPolicyName(String securityPolicyName)

The text name of the security policy for the specified connector.

Parameters:

securityPolicyName - The text name of the security policy for the specified connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-securitypolicyname

sftpConfig

@Stability(Stable)
public CfnConnector.Builder sftpConfig(IResolvable sftpConfig)

A structure that contains the parameters for an SFTP connector object.

Parameters:

sftpConfig - A structure that contains the parameters for an SFTP connector object. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-sftpconfig

sftpConfig

@Stability(Stable)
public CfnConnector.Builder sftpConfig(CfnConnector.SftpConfigProperty sftpConfig)

A structure that contains the parameters for an SFTP connector object.

Parameters:

sftpConfig - A structure that contains the parameters for an SFTP connector object. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-sftpconfig

tags

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-tags

url

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

The URL of the partner's AS2 or SFTP endpoint.

When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-connector.html#cfn-transfer-connector-url

build

@Stability(Stable)
public CfnConnector build()

Specified by:

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

Returns:

a newly built instance of CfnConnector.