Package software.amazon.awscdk.services.transfer

Interface CfnConnectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:41:02.153Z")
@Stability(Stable)
public interface CfnConnectorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConnector.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 Object as2Config;
 CfnConnectorProps cfnConnectorProps = CfnConnectorProps.builder()
         .accessRole("accessRole")
         // the properties below are optional
         .as2Config(as2Config)
         .egressConfig(ConnectorEgressConfigProperty.builder()
                 .vpcLattice(ConnectorVpcLatticeEgressConfigProperty.builder()
                         .resourceConfigurationArn("resourceConfigurationArn")
                         // the properties below are optional
                         .portNumber(123)
                         .build())
                 .build())
         .egressType("egressType")
         .loggingRole("loggingRole")
         .securityPolicyName("securityPolicyName")
         .sftpConfig(SftpConfigProperty.builder()
                 .maxConcurrentConnections(123)
                 .trustedHostKeys(List.of("trustedHostKeys"))
                 .userSecretId("userSecretId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .url("url")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorProps.Builder	A builder for CfnConnectorProps
static final class	CfnConnectorProps.Jsii$Proxy	An implementation for CfnConnectorProps

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProps.Builder	builder()
String	getAccessRole()	Connectors are used to send files using either the AS2 or SFTP protocol.
default Object	getAs2Config()	A structure that contains the parameters for an AS2 connector object.
default Object	getEgressConfig()	Current egress configuration of the connector, showing how traffic is routed to the SFTP server.
default String	getEgressType()	Type of egress configuration for the connector.
default String	getLoggingRole()	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.
default String	getSecurityPolicyName()	The text name of the security policy for the specified connector.
default Object	getSftpConfig()	A structure that contains the parameters for an SFTP connector object.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for connectors.
default String	getUrl()	The URL of the partner's AS2 or SFTP endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessRole

@Stability(Stable)
@NotNull
String getAccessRole()

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 .

See Also:

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

getAs2Config

@Stability(Stable)
@Nullable
default Object getAs2Config()

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

See Also:

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

getEgressConfig

@Stability(Stable)
@Nullable
default Object getEgressConfig()

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.

Returns union: either IResolvable or CfnConnector.ConnectorEgressConfigProperty

See Also:

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

getEgressType

@Stability(Stable)
@Nullable
default String getEgressType()

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.

See Also:

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

getLoggingRole

@Stability(Stable)
@Nullable
default String getLoggingRole()

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.

See Also:

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

getSecurityPolicyName

@Stability(Stable)
@Nullable
default String getSecurityPolicyName()

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

See Also:

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

getSftpConfig

@Stability(Stable)
@Nullable
default Object getSftpConfig()

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

Returns union: either IResolvable or CfnConnector.SftpConfigProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

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.

See Also:

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

builder

@Stability(Stable)
static CfnConnectorProps.Builder builder()

Returns:

a CfnConnectorProps.Builder of CfnConnectorProps