software.amazon.awssdk.services.transfer.model

Interface As2ConnectorConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>, SdkBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>, SdkPojo

Enclosing class:

As2ConnectorConfig

public static interface As2ConnectorConfig.Builder
extends SdkPojo, CopyableBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>

Method Summary

Modifier and Type	Method and Description
As2ConnectorConfig.Builder	basicAuthSecretId(String basicAuthSecretId) Provides Basic authentication support to the AS2 Connectors API.
As2ConnectorConfig.Builder	compression(CompressionEnum compression) Specifies whether the AS2 file is compressed.
As2ConnectorConfig.Builder	compression(String compression) Specifies whether the AS2 file is compressed.
As2ConnectorConfig.Builder	encryptionAlgorithm(EncryptionAlg encryptionAlgorithm) The algorithm that is used to encrypt the file.
As2ConnectorConfig.Builder	encryptionAlgorithm(String encryptionAlgorithm) The algorithm that is used to encrypt the file.
As2ConnectorConfig.Builder	localProfileId(String localProfileId) A unique identifier for the AS2 local profile.
As2ConnectorConfig.Builder	mdnResponse(MdnResponse 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.
As2ConnectorConfig.Builder	mdnResponse(String 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.
As2ConnectorConfig.Builder	mdnSigningAlgorithm(MdnSigningAlg mdnSigningAlgorithm) The signing algorithm for the MDN response.
As2ConnectorConfig.Builder	mdnSigningAlgorithm(String mdnSigningAlgorithm) The signing algorithm for the MDN response.
As2ConnectorConfig.Builder	messageSubject(String messageSubject) Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
As2ConnectorConfig.Builder	partnerProfileId(String partnerProfileId) A unique identifier for the partner profile for the connector.
As2ConnectorConfig.Builder	signingAlgorithm(SigningAlg signingAlgorithm) The algorithm that is used to sign the AS2 messages sent with the connector.
As2ConnectorConfig.Builder	signingAlgorithm(String signingAlgorithm) The algorithm that is used to sign the AS2 messages sent with the connector.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

localProfileId

As2ConnectorConfig.Builder localProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

partnerProfileId

As2ConnectorConfig.Builder partnerProfileId(String partnerProfileId)

A unique identifier for the partner profile for the connector.

Parameters:

partnerProfileId - A unique identifier for the partner profile for the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

messageSubject

As2ConnectorConfig.Builder messageSubject(String messageSubject)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

compression

As2ConnectorConfig.Builder compression(String compression)

Specifies whether the AS2 file is compressed.

Parameters:

compression - Specifies whether the AS2 file is compressed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CompressionEnum, CompressionEnum

compression

As2ConnectorConfig.Builder compression(CompressionEnum compression)

Specifies whether the AS2 file is compressed.

Parameters:

compression - Specifies whether the AS2 file is compressed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CompressionEnum, CompressionEnum

encryptionAlgorithm

As2ConnectorConfig.Builder encryptionAlgorithm(String encryptionAlgorithm)

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.

Parameters:

encryptionAlgorithm - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlg, EncryptionAlg

encryptionAlgorithm

As2ConnectorConfig.Builder encryptionAlgorithm(EncryptionAlg encryptionAlgorithm)

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.

Parameters:

encryptionAlgorithm - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlg, EncryptionAlg

signingAlgorithm

As2ConnectorConfig.Builder signingAlgorithm(String signingAlgorithm)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlg, SigningAlg

signingAlgorithm

As2ConnectorConfig.Builder signingAlgorithm(SigningAlg signingAlgorithm)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlg, SigningAlg

mdnSigningAlgorithm

As2ConnectorConfig.Builder mdnSigningAlgorithm(String mdnSigningAlgorithm)

The signing algorithm for the MDN response.

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

Parameters:

mdnSigningAlgorithm - The signing algorithm for the MDN response.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnSigningAlg, MdnSigningAlg

mdnSigningAlgorithm

As2ConnectorConfig.Builder mdnSigningAlgorithm(MdnSigningAlg mdnSigningAlgorithm)

The signing algorithm for the MDN response.

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

Parameters:

mdnSigningAlgorithm - The signing algorithm for the MDN response.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnSigningAlg, MdnSigningAlg

mdnResponse

As2ConnectorConfig.Builder mdnResponse(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnResponse, MdnResponse

mdnResponse

As2ConnectorConfig.Builder mdnResponse(MdnResponse 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnResponse, MdnResponse

basicAuthSecretId

As2ConnectorConfig.Builder basicAuthSecretId(String basicAuthSecretId)

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=""'

Parameters:

basicAuthSecretId - 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=""'

Returns:

Returns a reference to this object so that method calls can be chained together.