Class: Aws::Transfer::Types::ProtocolDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::ProtocolDetails
- Defined in:
- gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb
Overview
When making an API call, you may pass ProtocolDetails data as a hash:
{
passive_ip: "PassiveIp",
tls_session_resumption_mode: "DISABLED", # accepts DISABLED, ENABLED, ENFORCED
set_stat_option: "DEFAULT", # accepts DEFAULT, ENABLE_NO_OP
as_2_transports: ["HTTP"], # accepts HTTP
}
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.
-
#set_stat_option ⇒ String
Use the
SetStatOption
to ignore the error that is generated when the client attempts to useSETSTAT
on a file you are uploading to an S3 bucket. -
#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.
4520 4521 4522 4523 4524 4525 4526 4527 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4520 class ProtocolDetails < Struct.new( :passive_ip, :tls_session_resumption_mode, :set_stat_option, :as_2_transports) 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.
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.
4520 4521 4522 4523 4524 4525 4526 4527 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4520 class ProtocolDetails < Struct.new( :passive_ip, :tls_session_resumption_mode, :set_stat_option, :as_2_transports) 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.
SETSTAT
, you can use Amazon EFS
as backend storage with Transfer Family.
4520 4521 4522 4523 4524 4525 4526 4527 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4520 class ProtocolDetails < Struct.new( :passive_ip, :tls_session_resumption_mode, :set_stat_option, :as_2_transports) 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 toENFORCED
, 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.
4520 4521 4522 4523 4524 4525 4526 4527 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4520 class ProtocolDetails < Struct.new( :passive_ip, :tls_session_resumption_mode, :set_stat_option, :as_2_transports) SENSITIVE = [] include Aws::Structure end |