Class CfnConnectorPropsMixin.As2ConfigProperty

A structure that contains the parameters for an AS2 connector object.

Inheritance

object

CfnConnectorPropsMixin.As2ConfigProperty

Implements

CfnConnectorPropsMixin.IAs2ConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnConnectorPropsMixin.As2ConfigProperty : CfnConnectorPropsMixin.IAs2ConfigProperty

Syntax (vb)

Public Class CfnConnectorPropsMixin.As2ConfigProperty Implements CfnConnectorPropsMixin.IAs2ConfigProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins;

             var as2ConfigProperty = new As2ConfigProperty {
                 BasicAuthSecretId = "basicAuthSecretId",
                 Compression = "compression",
                 EncryptionAlgorithm = "encryptionAlgorithm",
                 LocalProfileId = "localProfileId",
                 MdnResponse = "mdnResponse",
                 MdnSigningAlgorithm = "mdnSigningAlgorithm",
                 MessageSubject = "messageSubject",
                 PartnerProfileId = "partnerProfileId",
                 PreserveContentType = "preserveContentType",
                 SigningAlgorithm = "signingAlgorithm"
             };

Synopsis

Constructors

As2ConfigProperty()

A structure that contains the parameters for an AS2 connector object.

Properties

BasicAuthSecretId	Provides Basic authentication support to the AS2 Connectors API.
Compression	Specifies whether the AS2 file is compressed.
EncryptionAlgorithm	The algorithm that is used to encrypt the file.
LocalProfileId	A unique identifier for the AS2 local profile.
MdnResponse	Used for outbound requests (from an AWS Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.
MdnSigningAlgorithm	The signing algorithm for the MDN response.
MessageSubject	Used as the `Subject` HTTP header attribute in AS2 messages that are being sent with the connector.
PartnerProfileId	A unique identifier for the partner profile for the connector.
PreserveContentType	Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.
SigningAlgorithm	The algorithm that is used to sign the AS2 messages sent with the connector.

Constructors

As2ConfigProperty()

A structure that contains the parameters for an AS2 connector object.

public As2ConfigProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins;

             var as2ConfigProperty = new As2ConfigProperty {
                 BasicAuthSecretId = "basicAuthSecretId",
                 Compression = "compression",
                 EncryptionAlgorithm = "encryptionAlgorithm",
                 LocalProfileId = "localProfileId",
                 MdnResponse = "mdnResponse",
                 MdnSigningAlgorithm = "mdnSigningAlgorithm",
                 MessageSubject = "messageSubject",
                 PartnerProfileId = "partnerProfileId",
                 PreserveContentType = "preserveContentType",
                 SigningAlgorithm = "signingAlgorithm"
             };

Properties

BasicAuthSecretId

Provides Basic authentication support to the AS2 Connectors API.

public string? BasicAuthSecretId { get; set; }

Property Value

string

Remarks

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:

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html#cfn-transfer-connector-as2config-basicauthsecretid

Compression

Specifies whether the AS2 file is compressed.

public string? Compression { get; set; }

Property Value

string

Remarks

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

EncryptionAlgorithm

The algorithm that is used to encrypt the file.

public string? EncryptionAlgorithm { get; set; }

Property Value

string

Remarks

Note the following:

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

LocalProfileId

A unique identifier for the AS2 local profile.

public string? LocalProfileId { get; set; }

Property Value

string

Remarks

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

MdnResponse

Used for outbound requests (from an AWS Transfer Family connector to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.

public string? MdnResponse { get; set; }

Property Value

string

Remarks

Specify either of the following values:

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

MdnSigningAlgorithm

The signing algorithm for the MDN response.

public string? MdnSigningAlgorithm { get; set; }

Property Value

string

Remarks

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

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

MessageSubject

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

public string? MessageSubject { get; set; }

Property Value

string

Remarks

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

PartnerProfileId

A unique identifier for the partner profile for the connector.

public string? PartnerProfileId { get; set; }

Property Value

string

Remarks

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

PreserveContentType

Specifies whether to use the AWS S3 object content-type as the content-type for the AS2 message.

public string? PreserveContentType { get; set; }

Property Value

string

Remarks

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

SigningAlgorithm

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

public string? SigningAlgorithm { get; set; }