Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Class CfnConnectorPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnConnectorPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.868Z")
@Stability(Stable)
public class CfnConnectorPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol.

For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors .

You must specify exactly one configuration object: either for AS2 ( As2Config ) or SFTP ( SftpConfig ).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.transfer.*;
 import software.amazon.awscdk.*;
 Object as2Config;
 IMergeStrategy mergeStrategy;
 CfnConnectorPropsMixin cfnConnectorPropsMixin = CfnConnectorPropsMixin.Builder.create(CfnConnectorMixinProps.builder()
         .accessRole("accessRole")
         .as2Config(as2Config)
         .egressConfig(ConnectorEgressConfigProperty.builder()
                 .vpcLattice(ConnectorVpcLatticeEgressConfigProperty.builder()
                         .portNumber(123)
                         .resourceConfigurationArn("resourceConfigurationArn")
                         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConnectorPropsMixin.As2ConfigProperty	A structure that contains the parameters for an AS2 connector object.
static final class	CfnConnectorPropsMixin.Builder	A fluent builder for CfnConnectorPropsMixin.
static interface	CfnConnectorPropsMixin.ConnectorAsyncMdnConfigProperty	Example:
static interface	CfnConnectorPropsMixin.ConnectorEgressConfigProperty	Configuration structure that defines how traffic is routed from the connector to the SFTP server.
static interface	CfnConnectorPropsMixin.ConnectorVpcLatticeEgressConfigProperty	VPC_LATTICE egress configuration that specifies the Resource Configuration ARN and port for connecting to SFTP servers through customer VPCs.
static interface	CfnConnectorPropsMixin.SftpConfigProperty	A structure that contains the parameters for an SFTP connector object.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnConnectorPropsMixin(CfnConnectorMixinProps props)	Create a mixin to apply properties to AWS::Transfer::Connector.
	CfnConnectorPropsMixin(CfnConnectorMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Transfer::Connector.
protected	CfnConnectorPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnConnectorMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnConnectorPropsMixin

protected CfnConnectorPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnConnectorPropsMixin

protected CfnConnectorPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConnectorPropsMixin

@Stability(Stable)
public CfnConnectorPropsMixin(@NotNull
 CfnConnectorMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Transfer::Connector.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnConnectorPropsMixin

@Stability(Stable)
public CfnConnectorPropsMixin(@NotNull
 CfnConnectorMixinProps props)

Create a mixin to apply properties to AWS::Transfer::Connector.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnConnectorMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()