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 an AS2 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()
         .basicAuthSecretId("basicAuthSecretId")
         .compression("compression")
         .encryptionAlgorithm("encryptionAlgorithm")
         .localProfileId("localProfileId")
         .mdnResponse("mdnResponse")
         .mdnSigningAlgorithm("mdnSigningAlgorithm")
         .messageSubject("messageSubject")
         .partnerProfileId("partnerProfileId")
         .signingAlgorithm("signingAlgorithm")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnector.As2ConfigProperty.Builder	builder()
default String	getBasicAuthSecretId()	Provides Basic authentication support to the AS2 Connectors API.
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 Details

getBasicAuthSecretId

@Stability(Stable)
@Nullable
default String getBasicAuthSecretId()

Provides Basic authentication support to the AS2 Connectors API.

To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in AWS Secrets Manager .

The default value for this parameter is null , which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.
• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the AWS management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-basicauthsecretid

getCompression

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

Specifies whether the AS2 file is compressed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-compression

getEncryptionAlgorithm

@Stability(Stable)
@Nullable
default String getEncryptionAlgorithm()

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.
• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-encryptionalgorithm

getLocalProfileId

@Stability(Stable)
@Nullable
default String getLocalProfileId()

A unique identifier for the AS2 local profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-localprofileid

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-mdnresponse

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-mdnsigningalgorithm

getMessageSubject

@Stability(Stable)
@Nullable
default String getMessageSubject()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-messagesubject

getPartnerProfileId

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

A unique identifier for the partner profile for the connector.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-partnerprofileid

getSigningAlgorithm

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-signingalgorithm

builder

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

Returns:

a CfnConnector.As2ConfigProperty.Builder of CfnConnector.As2ConfigProperty