Class ProtocolDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProtocolDetails.Builder,
ProtocolDetails>
The protocol settings that are configured for your server.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<As2Transport> Indicates the transport method for the AS2 messages.Indicates the transport method for the AS2 messages.static ProtocolDetails.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the As2Transports property.final int
hashCode()
final String
Indicates passive mode, for FTP and FTPS protocols.static Class
<? extends ProtocolDetails.Builder> final SetStatOption
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.final 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.final TlsSessionResumptionMode
A property used with Transfer Family servers that use the FTPS protocol.final String
A property used with Transfer Family servers that use the FTPS protocol.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
passiveIp
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.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.- Returns:
- 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.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.
-
tlsSessionResumptionMode
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.
If the service returns an enum value that is not available in the current SDK version,
tlsSessionResumptionMode
will returnTlsSessionResumptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtlsSessionResumptionModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
tlsSessionResumptionModeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
tlsSessionResumptionMode
will returnTlsSessionResumptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtlsSessionResumptionModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
setStatOption
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.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.If the service returns an enum value that is not available in the current SDK version,
setStatOption
will returnSetStatOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsetStatOptionAsString()
.- Returns:
- 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.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. - See Also:
-
setStatOptionAsString
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.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.If the service returns an enum value that is not available in the current SDK version,
setStatOption
will returnSetStatOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsetStatOptionAsString()
.- Returns:
- 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.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. - See Also:
-
as2Transports
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAs2Transports()
method.- Returns:
- Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
-
hasAs2Transports
public final boolean hasAs2Transports()For responses, this returns true if the service returned a value for the As2Transports property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
as2TransportsAsStrings
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAs2Transports()
method.- Returns:
- Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProtocolDetails.Builder,
ProtocolDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-