aws-cdk-lib.aws_transfer.CfnConnector.As2ConfigProperty

interface As2ConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnConnector.As2ConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnConnector_As2ConfigProperty
Javasoftware.amazon.awscdk.services.transfer.CfnConnector.As2ConfigProperty
Pythonaws_cdk.aws_transfer.CfnConnector.As2ConfigProperty
TypeScript aws-cdk-lib » aws_transfer » CfnConnector » As2ConfigProperty

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 { aws_transfer as transfer } from 'aws-cdk-lib';
const as2ConfigProperty: transfer.CfnConnector.As2ConfigProperty = {
  compression: 'compression',
  encryptionAlgorithm: 'encryptionAlgorithm',
  localProfileId: 'localProfileId',
  mdnResponse: 'mdnResponse',
  mdnSigningAlgorithm: 'mdnSigningAlgorithm',
  messageSubject: 'messageSubject',
  partnerProfileId: 'partnerProfileId',
  signingAlgorithm: 'signingAlgorithm',
};

Properties

NameTypeDescription
compression?stringSpecifies whether the AS2 file is compressed.
encryptionAlgorithm?stringThe algorithm that is used to encrypt the file.
localProfileId?stringA unique identifier for the AS2 local profile.
mdnResponse?stringUsed 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.
mdnSigningAlgorithm?stringThe signing algorithm for the MDN response.
messageSubject?stringUsed as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
partnerProfileId?stringA unique identifier for the partner profile for the connector.
signingAlgorithm?stringThe algorithm that is used to sign the AS2 messages sent with the connector.

compression?

Type: string (optional)

Specifies whether the AS2 file is compressed.


encryptionAlgorithm?

Type: string (optional)

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.


localProfileId?

Type: string (optional)

A unique identifier for the AS2 local profile.


mdnResponse?

Type: string (optional)

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.

mdnSigningAlgorithm?

Type: string (optional)

The signing algorithm for the MDN response.

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


messageSubject?

Type: string (optional)

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


partnerProfileId?

Type: string (optional)

A unique identifier for the partner profile for the connector.


signingAlgorithm?

Type: string (optional)

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