Class: Aws::Transfer::Types::ProtocolDetails

Inherits:

Struct

Object
Struct
Aws::Transfer::Types::ProtocolDetails

show all

Defined in:: gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

The protocol settings that are configured for your server.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#as_2_transports ⇒ Array<String>
Indicates the transport method for the AS2 messages.
#passive_ip ⇒ String
Indicates passive mode, for FTP and FTPS protocols.
#proxy_config ⇒ Types::ProxyConfig
The configuration for PROXY protocol version 2 (PPv2) support on the Transfer Family server.
#set_stat_option ⇒ String
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.
#sftp_ports ⇒ Array<Types::SftpPortWithOptions>
A property used with Transfer Family servers that use the SFTP protocol and have PUBLIC endpoints.
#tls_session_resumption_mode ⇒ String
A property used with Transfer Family servers that use the FTPS protocol.

Instance Attribute Details

#as_2_transports ⇒ `Array<String>`

Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

Returns:

(Array<String>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

#passive_ip ⇒ `String`

Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:

aws transfer update-server --protocol-details PassiveIp=0.0.0.0

Replace 0.0.0.0 in the example above with the actual IP address you want to use.

If you change the PassiveIp value, you must stop and then restart your Transfer Family server for the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.

Additionally, avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers. This configuration increases costs and can cause performance issues. When NLBs or NATs are in the communication path, Transfer Family cannot accurately recognize client IP addresses, which impacts connection sharding and limits FTPS servers to only 300 simultaneous connections instead of 10,000. If you must use an NLB, use port 21 for health checks and enable TLS session resumption by setting TlsSessionResumptionMode = ENFORCED. For optimal performance, migrate to VPC endpoints with Elastic IP addresses instead of using NLBs. For more details, see Avoid placing NLBs and NATs in front of Transfer Family.

Special values

The AUTO and 0.0.0.0 are special values for the PassiveIp parameter. The value PassiveIp=AUTO is assigned by default to FTP and FTPS type servers. In this case, the server automatically responds with one of the endpoint IPs within the PASV response. PassiveIp=0.0.0.0 has a more unique application for its usage. For example, if you have a High Availability (HA) Network Load Balancer (NLB) environment, where you have 3 subnets, you can only specify a single IP address using the PassiveIp parameter. This reduces the effectiveness of having High Availability. In this case, you can specify PassiveIp=0.0.0.0. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections. Note, however, that not all FTP clients support the PassiveIp=0.0.0.0 response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports the PassiveIp=0.0.0.0 response.

Returns:

(String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_config ⇒ `Types::ProxyConfig`

The configuration for PROXY protocol version 2 (PPv2) support on the Transfer Family server. For more information, see Working with Network Load Balancers.

Returns:

(Types::ProxyConfig)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

#set_stat_option ⇒ `String`

Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.

Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file. However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when the file is otherwise successfully uploaded.

Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. While the SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.

If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.

Returns:

(String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

#sftp_ports ⇒ `Array<Types::SftpPortWithOptions>`

A property used with Transfer Family servers that use the SFTP protocol and have PUBLIC endpoints. This property accepts a list of up to three port configurations that the service opens on the server endpoint.

Each entry in the list consists of two parameters, the SftpPort and the CommunicationMode. The SftpPort takes any integer from 2000 to 65535, or 22. CommunicationMode can be one of the following options:

SERVER_TALK_FIRST: The server responds to initial TCP connections first. Many older clients expect that an SFTP server responds with its server string before starting SSH negotiations.
CLIENT_TALK_FIRST: The server responds to the initial TCP connection only after receiving a data packet. Most modern clients support this behavior and send their client string along with the initial data packets for SSH negotiation. Additionally, this mode is more resilient to TCP retransmissions that can occur during the initial TCP connection.

The following is an SftpPorts example for port 2222 with CLIENT_TALK_FIRST.

[ { "SftpPort": 2222, "CommunicationMode": "CLIENT_TALK_FIRST" } ]

If you don't specify any configurations during CreateServer, the service uses port 22 with SERVER_TALK_FIRST by default.

Returns:

(Array<Types::SftpPortWithOptions>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

#tls_session_resumption_mode ⇒ `String`

A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls. If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.
ENABLED: the server processes and accepts clients that are performing TLS session resumption. The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The server rejects client data connections that do not perform the TLS session resumption client processing. Before you set the value to ENFORCED, test your clients.

Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or not you can use the ENFORCED value, you need to test your clients.

Returns:

(String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 5951

class ProtocolDetails < Struct.new(
  :passive_ip,
  :tls_session_resumption_mode,
  :set_stat_option,
  :sftp_ports,
  :as_2_transports,
  :proxy_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Transfer::Types::ProtocolDetails

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#as_2_transports ⇒ Array<String>

#passive_ip ⇒ String

#proxy_config ⇒ Types::ProxyConfig

#set_stat_option ⇒ String

#sftp_ports ⇒ Array<Types::SftpPortWithOptions>

#tls_session_resumption_mode ⇒ String

#as_2_transports ⇒ `Array<String>`

#passive_ip ⇒ `String`

#proxy_config ⇒ `Types::ProxyConfig`

#set_stat_option ⇒ `String`

#sftp_ports ⇒ `Array<Types::SftpPortWithOptions>`

#tls_session_resumption_mode ⇒ `String`