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.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.914Z") @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")
         .as2Config(as2Config)
         .url("url")
         // the properties below are optional
         .loggingRole("loggingRole")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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()
    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths .
    Object
    getAs2Config()
    A structure that contains the parameters for a connector object.
    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 List<CfnTag>
    getTags()
    Key-value pairs that can be used to group and search for connectors.
    String
    getUrl()
    The URL of the partner's AS2 endpoint.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getAccessRole

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

    • getAs2Config

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

    • getUrl

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

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

    • getTags

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

    • builder

      @Stability(Stable) static CfnConnectorProps.Builder builder()
      Returns:
      a CfnConnectorProps.Builder of CfnConnectorProps