Package software.amazon.awscdk.services.transfer

Interface CfnConnector.As2ConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnConnector.As2ConfigProperty.Jsii$Proxy
Enclosing class:
CfnConnector
@Stability(Stable) public static interface CfnConnector.As2ConfigProperty extends software.amazon.jsii.JsiiSerializable
A structure that contains the parameters for a connector object.

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.*;
 As2ConfigProperty as2ConfigProperty = As2ConfigProperty.builder()
         .compression("compression")
         .encryptionAlgorithm("encryptionAlgorithm")
         .localProfileId("localProfileId")
         .mdnResponse("mdnResponse")
         .mdnSigningAlgorithm("mdnSigningAlgorithm")
         .messageSubject("messageSubject")
         .partnerProfileId("partnerProfileId")
         .signingAlgorithm("signingAlgorithm")
         .build();

  • Method Details

    • getCompression

      @Stability(Stable) @Nullable default String getCompression()
      Specifies whether the AS2 file is compressed.

    • getEncryptionAlgorithm

      @Stability(Stable) @Nullable default String getEncryptionAlgorithm()
      The algorithm that is used to encrypt the file.

      You can only specify NONE if the URL for your connector uses HTTPS. This ensures that no traffic is sent in clear text.

    • getLocalProfileId

      @Stability(Stable) @Nullable default String getLocalProfileId()
      A unique identifier for the AS2 local profile.

    • getMdnResponse

      @Stability(Stable) @Nullable default String getMdnResponse()
      Used for outbound requests (from an AWS Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.

      Specify either of the following values:

      • SYNC : The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).
      • NONE : Specifies that no MDN response is required.

    • getMdnSigningAlgorithm

      @Stability(Stable) @Nullable default String getMdnSigningAlgorithm()
      The signing algorithm for the MDN response.

      If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

    • getMessageSubject

      @Stability(Stable) @Nullable default String getMessageSubject()
      Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

    • getPartnerProfileId

      @Stability(Stable) @Nullable default String getPartnerProfileId()
      A unique identifier for the partner profile for the connector.

    • getSigningAlgorithm

      @Stability(Stable) @Nullable default String getSigningAlgorithm()
      The algorithm that is used to sign the AS2 messages sent with the connector.

    • builder

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