Package software.amazon.awscdk.services.transfer

Class CfnConnector

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnConnector
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectorRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.010Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable, IConnectorRef, ITaggable
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.services.transfer.*;
 Object as2Config;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConnector

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

    • CfnConnector

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

    • CfnConnector

      @Stability(Stable) public CfnConnector(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProps props)
      Create a new AWS::Transfer::Connector.

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

  • Method Details

    • arnForConnector

      @Stability(Stable) @NotNull public static String arnForConnector(@NotNull IConnectorRef resource)
      Parameters:
      resource - This parameter is required.

    • fromConnectorArn

      @Stability(Stable) @NotNull public static IConnectorRef fromConnectorArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IConnectorRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromConnectorId

      @Stability(Stable) @NotNull public static IConnectorRef fromConnectorId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String connectorId)
      Creates a new IConnectorRef from a connectorId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      connectorId - This parameter is required.

    • isCfnConnector

      @Stability(Stable) @NotNull public static Boolean isCfnConnector(@NotNull Object x)
      Checks whether the given object is a CfnConnector.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Specifies the unique Amazon Resource Name (ARN) for the connector.

    • getAttrConnectorId

      @Stability(Stable) @NotNull public String getAttrConnectorId()
      The service-assigned ID of the connector that is created.

    • getAttrServiceManagedEgressIpAddresses

      @Stability(Stable) @NotNull public List<String> getAttrServiceManagedEgressIpAddresses()
      The list of egress IP addresses of this connector.

      These IP addresses are assigned automatically when you create the connector.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Current status of the connector.

      PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConnectorRef

      @Stability(Stable) @NotNull public ConnectorReference getConnectorRef()
      A reference to a Connector resource.
      Specified by:
      getConnectorRef in interface IConnectorRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAccessRole

      @Stability(Stable) @NotNull public String getAccessRole()
      Connectors are used to send files using either the AS2 or SFTP protocol.

    • setAccessRole

      @Stability(Stable) public void setAccessRole(@NotNull String value)
      Connectors are used to send files using either the AS2 or SFTP protocol.

    • getAs2Config

      @Stability(Stable) @Nullable public Object getAs2Config()
      A structure that contains the parameters for an AS2 connector object.

    • setAs2Config

      @Stability(Stable) public void setAs2Config(@Nullable Object value)
      A structure that contains the parameters for an AS2 connector object.

    • getEgressConfig

      @Stability(Stable) @Nullable public Object getEgressConfig()
      Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

      Returns union: either IResolvable or CfnConnector.ConnectorEgressConfigProperty

    • setEgressConfig

      @Stability(Stable) public void setEgressConfig(@Nullable IResolvable value)
      Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

    • setEgressConfig

      @Stability(Stable) public void setEgressConfig(@Nullable CfnConnector.ConnectorEgressConfigProperty value)
      Current egress configuration of the connector, showing how traffic is routed to the SFTP server.

    • getEgressType

      @Stability(Stable) @Nullable public String getEgressType()
      Type of egress configuration for the connector.

    • setEgressType

      @Stability(Stable) public void setEgressType(@Nullable String value)
      Type of egress configuration for the connector.

    • getLoggingRole

      @Stability(Stable) @Nullable public 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.

    • setLoggingRole

      @Stability(Stable) public void setLoggingRole(@Nullable String value)
      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.

    • getSecurityPolicyName

      @Stability(Stable) @Nullable public String getSecurityPolicyName()
      The text name of the security policy for the specified connector.

    • setSecurityPolicyName

      @Stability(Stable) public void setSecurityPolicyName(@Nullable String value)
      The text name of the security policy for the specified connector.

    • getSftpConfig

      @Stability(Stable) @Nullable public Object getSftpConfig()
      A structure that contains the parameters for an SFTP connector object.

      Returns union: either IResolvable or CfnConnector.SftpConfigProperty

    • setSftpConfig

      @Stability(Stable) public void setSftpConfig(@Nullable IResolvable value)
      A structure that contains the parameters for an SFTP connector object.

    • setSftpConfig

      @Stability(Stable) public void setSftpConfig(@Nullable CfnConnector.SftpConfigProperty value)
      A structure that contains the parameters for an SFTP connector object.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for connectors.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for connectors.

    • getUrl

      @Stability(Stable) @Nullable public String getUrl()
      The URL of the partner's AS2 or SFTP endpoint.

    • setUrl

      @Stability(Stable) public void setUrl(@Nullable String value)
      The URL of the partner's AS2 or SFTP endpoint.