Package software.amazon.awscdk.services.transfer

Class CfnConnector

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.transfer.CfnConnector
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.911Z") @Stability(Stable) public class CfnConnector extends CfnResource implements IInspectable
A CloudFormation AWS::Transfer::Connector.

Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. For more details about connectors, see Create AS2 connectors .

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")
         .as2Config(as2Config)
         .url("url")
         // the properties below are optional
         .loggingRole("loggingRole")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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()

    • getAttrConnectorId

      @Stability(Stable) @NotNull public String getAttrConnectorId()

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs that can be used to group and search for connectors.

    • getAccessRole

      @Stability(Stable) @NotNull public String getAccessRole()
      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 .

    • setAccessRole

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

    • getAs2Config

      @Stability(Stable) @NotNull public Object getAs2Config()
      A structure that contains the parameters for a connector object.

    • setAs2Config

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

    • getUrl

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

    • setUrl

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

    • 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.

      When set, you can view connector activity in your CloudWatch logs.

    • 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.

      When set, you can view connector activity in your CloudWatch logs.