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(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnConnector.As2ConfigProperty.Builder A builder for CfnConnector.As2ConfigProperty
static class	CfnConnector.As2ConfigProperty.Jsii$Proxy An implementation for CfnConnector.As2ConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnConnector.As2ConfigProperty.Builder	builder()
default String	getCompression() Specifies whether the AS2 file is compressed.
default String	getEncryptionAlgorithm() The algorithm that is used to encrypt the file.
default String	getLocalProfileId() A unique identifier for the AS2 local profile.
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.
default String	getMdnSigningAlgorithm() The signing algorithm for the MDN response.
default String	getMessageSubject() Used as the `Subject` HTTP header attribute in AS2 messages that are being sent with the connector.
default String	getPartnerProfileId() A unique identifier for the partner profile for the connector.
default String	getSigningAlgorithm() The algorithm that is used to sign the AS2 messages sent with the connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCompression

@Stability(value=Stable)
 @Nullable
default String getCompression()

Specifies whether the AS2 file is compressed.

getEncryptionAlgorithm

@Stability(value=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(value=Stable)
 @Nullable
default String getLocalProfileId()

A unique identifier for the AS2 local profile.

getMdnResponse

@Stability(value=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(value=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(value=Stable)
 @Nullable
default String getMessageSubject()

Used as the `Subject` HTTP header attribute in AS2 messages that are being sent with the connector.

getPartnerProfileId

@Stability(value=Stable)
 @Nullable
default String getPartnerProfileId()

A unique identifier for the partner profile for the connector.

getSigningAlgorithm

@Stability(value=Stable)
 @Nullable
default String getSigningAlgorithm()

The algorithm that is used to sign the AS2 messages sent with the connector.

builder

@Stability(value=Stable)
static CfnConnector.As2ConfigProperty.Builder builder()

Returns:

a CfnConnector.As2ConfigProperty.Builder of CfnConnector.As2ConfigProperty