Interface CfnServer.ProtocolDetailsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServer.ProtocolDetailsProperty.Jsii$Proxy
- Enclosing class:
CfnServer
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.transfer.*; ProtocolDetailsProperty protocolDetailsProperty = ProtocolDetailsProperty.builder() .as2Transports(List.of("as2Transports")) .passiveIp("passiveIp") .setStatOption("setStatOption") .tlsSessionResumptionMode("tlsSessionResumptionMode") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnServer.ProtocolDetailsProperty
static final class
An implementation forCfnServer.ProtocolDetailsProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
List ofAs2Transport
objects.default String
Indicates passive mode, for FTP and FTPS protocols.default String
Use theSetStatOption
to ignore the error that is generated when the client attempts to useSETSTAT
on a file you are uploading to an S3 bucket.default String
A property used with Transfer Family servers that use the FTPS protocol.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAs2Transports
List ofAs2Transport
objects. -
getPassiveIp
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 AWS Transfer Family .Special values
The
AUTO
and0.0.0.0
are special values for thePassiveIp
parameter. The valuePassiveIp=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 thePassiveIp
parameter. This reduces the effectiveness of having High Availability. In this case, you can specifyPassiveIp=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 thePassiveIp=0.0.0.0
response. FileZilla and WinSCP do support it. If you are using other clients, check to see if your client supports thePassiveIp=0.0.0.0
response. -
getSetStatOption
Use theSetStatOption
to ignore the error that is generated when the client attempts to useSETSTAT
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 theSETSTAT
command, and upload files without needing to make any changes to your SFTP client. While theSetStatOption
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 aSETSTAT
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. -
getTlsSessionResumptionMode
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 duringCreateServer
andUpdateServer
calls. If aTlsSessionResumptionMode
value is not specified duringCreateServer
, it is set toENFORCED
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. -
builder
-