Struct aws_sdk_transfer::types::builders::ProtocolDetailsBuilder
source · #[non_exhaustive]pub struct ProtocolDetailsBuilder { /* private fields */ }
Expand description
A builder for ProtocolDetails
.
Implementations§
source§impl ProtocolDetailsBuilder
impl ProtocolDetailsBuilder
sourcepub fn passive_ip(self, input: impl Into<String>) -> Self
pub fn passive_ip(self, input: impl Into<String>) -> Self
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
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.
sourcepub fn set_passive_ip(self, input: Option<String>) -> Self
pub fn set_passive_ip(self, input: Option<String>) -> Self
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
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.
sourcepub fn get_passive_ip(&self) -> &Option<String>
pub fn get_passive_ip(&self) -> &Option<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.
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.
sourcepub fn tls_session_resumption_mode(
self,
input: TlsSessionResumptionMode,
) -> Self
pub fn tls_session_resumption_mode( self, input: TlsSessionResumptionMode, ) -> Self
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.
sourcepub fn set_tls_session_resumption_mode(
self,
input: Option<TlsSessionResumptionMode>,
) -> Self
pub fn set_tls_session_resumption_mode( self, input: Option<TlsSessionResumptionMode>, ) -> Self
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.
sourcepub fn get_tls_session_resumption_mode(
&self,
) -> &Option<TlsSessionResumptionMode>
pub fn get_tls_session_resumption_mode( &self, ) -> &Option<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 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.
sourcepub fn set_stat_option(self, input: SetStatOption) -> Self
pub fn set_stat_option(self, input: SetStatOption) -> Self
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.
sourcepub fn set_set_stat_option(self, input: Option<SetStatOption>) -> Self
pub fn set_set_stat_option(self, input: Option<SetStatOption>) -> Self
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.
sourcepub fn get_set_stat_option(&self) -> &Option<SetStatOption>
pub fn get_set_stat_option(&self) -> &Option<SetStatOption>
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.
sourcepub fn as2_transports(self, input: As2Transport) -> Self
pub fn as2_transports(self, input: As2Transport) -> Self
Appends an item to as2_transports
.
To override the contents of this collection use set_as2_transports
.
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
sourcepub fn set_as2_transports(self, input: Option<Vec<As2Transport>>) -> Self
pub fn set_as2_transports(self, input: Option<Vec<As2Transport>>) -> Self
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
sourcepub fn get_as2_transports(&self) -> &Option<Vec<As2Transport>>
pub fn get_as2_transports(&self) -> &Option<Vec<As2Transport>>
Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
sourcepub fn build(self) -> ProtocolDetails
pub fn build(self) -> ProtocolDetails
Consumes the builder and constructs a ProtocolDetails
.
Trait Implementations§
source§impl Clone for ProtocolDetailsBuilder
impl Clone for ProtocolDetailsBuilder
source§fn clone(&self) -> ProtocolDetailsBuilder
fn clone(&self) -> ProtocolDetailsBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ProtocolDetailsBuilder
impl Debug for ProtocolDetailsBuilder
source§impl Default for ProtocolDetailsBuilder
impl Default for ProtocolDetailsBuilder
source§fn default() -> ProtocolDetailsBuilder
fn default() -> ProtocolDetailsBuilder
source§impl PartialEq for ProtocolDetailsBuilder
impl PartialEq for ProtocolDetailsBuilder
source§fn eq(&self, other: &ProtocolDetailsBuilder) -> bool
fn eq(&self, other: &ProtocolDetailsBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ProtocolDetailsBuilder
Auto Trait Implementations§
impl Freeze for ProtocolDetailsBuilder
impl RefUnwindSafe for ProtocolDetailsBuilder
impl Send for ProtocolDetailsBuilder
impl Sync for ProtocolDetailsBuilder
impl Unpin for ProtocolDetailsBuilder
impl UnwindSafe for ProtocolDetailsBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more