Class: Aws::Transfer::Types::As2ConnectorConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_secret_id ⇒ 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=""'

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#compression ⇒ String

Specifies whether the AS2 file is compressed.

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_algorithm ⇒ String

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.

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#local_profile_id ⇒ String

A unique identifier for the AS2 local profile.

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#mdn_response ⇒ String

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:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#mdn_signing_algorithm ⇒ String

The signing algorithm for the MDN response.

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

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#message_subject ⇒ String

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

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#partner_profile_id ⇒ String

A unique identifier for the partner profile for the connector.

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#signing_algorithm ⇒ String

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

Returns:

  • (String) 


124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 124

class As2ConnectorConfig < Struct.new(
  :local_profile_id,
  :partner_profile_id,
  :message_subject,
  :compression,
  :encryption_algorithm,
  :signing_algorithm,
  :mdn_signing_algorithm,
  :mdn_response,
  :basic_auth_secret_id)
  SENSITIVE = []
  include Aws::Structure
end