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

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

Overview

Note:

When making an API call, you may pass As2ConnectorConfig data as a hash:

{
  local_profile_id: "ProfileId",
  partner_profile_id: "ProfileId",
  message_subject: "MessageSubject",
  compression: "ZLIB", # accepts ZLIB, DISABLED
  encryption_algorithm: "AES128_CBC", # accepts AES128_CBC, AES192_CBC, AES256_CBC, NONE
  signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE
  mdn_signing_algorithm: "SHA256", # accepts SHA256, SHA384, SHA512, SHA1, NONE, DEFAULT
  mdn_response: "SYNC", # accepts SYNC, NONE
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compressionString

Specifies whether the AS2 file is compressed.

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#encryption_algorithmString

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:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#local_profile_idString

A unique identifier for the AS2 local profile.

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#mdn_responseString

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)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#mdn_signing_algorithmString

The signing algorithm for the MDN response.

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

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#message_subjectString

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

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#partner_profile_idString

A unique identifier for the partner profile for the connector.

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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

#signing_algorithmString

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

Returns:

  • (String)


98
99
100
101
102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 98

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