Struct aws_sdk_transfer::types::As2ConnectorConfig

#[non_exhaustive]
pub struct As2ConnectorConfig {
    pub local_profile_id: Option<String>,
    pub partner_profile_id: Option<String>,
    pub message_subject: Option<String>,
    pub compression: Option<CompressionEnum>,
    pub encryption_algorithm: Option<EncryptionAlg>,
    pub signing_algorithm: Option<SigningAlg>,
    pub mdn_signing_algorithm: Option<MdnSigningAlg>,
    pub mdn_response: Option<MdnResponse>,
    pub basic_auth_secret_id: Option<String>,
}

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

local_profile_id: Option<String>

A unique identifier for the AS2 local profile.

partner_profile_id: Option<String>

A unique identifier for the partner profile for the connector.

message_subject: Option<String>

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

compression: Option<CompressionEnum>

Specifies whether the AS2 file is compressed.

encryption_algorithm: Option<EncryptionAlg>

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.

signing_algorithm: Option<SigningAlg>

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

mdn_signing_algorithm: Option<MdnSigningAlg>

The signing algorithm for the MDN response.

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

mdn_response: Option<MdnResponse>

Used for outbound requests (from an 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.

basic_auth_secret_id: Option<String>

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 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 Amazon Web Services 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=""'

Implementations

impl As2ConnectorConfig

pub fn local_profile_id(&self) -> Option<&str>

A unique identifier for the AS2 local profile.

pub fn partner_profile_id(&self) -> Option<&str>

A unique identifier for the partner profile for the connector.

pub fn message_subject(&self) -> Option<&str>

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

pub fn compression(&self) -> Option<&CompressionEnum>

Specifies whether the AS2 file is compressed.

pub fn encryption_algorithm(&self) -> Option<&EncryptionAlg>

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.

pub fn signing_algorithm(&self) -> Option<&SigningAlg>

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

pub fn mdn_signing_algorithm(&self) -> Option<&MdnSigningAlg>

The signing algorithm for the MDN response.

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

pub fn mdn_response(&self) -> Option<&MdnResponse>

Used for outbound requests (from an 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.

pub fn basic_auth_secret_id(&self) -> Option<&str>

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 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 Amazon Web Services 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=""'

impl As2ConnectorConfig

pub fn builder() -> As2ConnectorConfigBuilder

Creates a new builder-style object to manufacture As2ConnectorConfig.

Trait Implementations

impl Clone for As2ConnectorConfig

fn clone(&self) -> As2ConnectorConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for As2ConnectorConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for As2ConnectorConfig

fn eq(&self, other: &As2ConnectorConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for As2ConnectorConfig