Amazonka.Transfer.Types.ProtocolDetails

Documentation

data ProtocolDetails

The protocol settings that are configured for your server.

See: newProtocolDetails smart constructor.

Constructors

ProtocolDetails'

Fields

• as2Transports :: Maybe (NonEmpty As2Transport)

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

• passiveIp :: Maybe Text

  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.

• setStatOption :: Maybe 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.

• tlsSessionResumptionMode :: Maybe 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 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.

Instances

FromJSON ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

parseJSON :: Value -> Parser ProtocolDetails

parseJSONList :: Value -> Parser [ProtocolDetails]

ToJSON ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

toJSON :: ProtocolDetails -> Value

toEncoding :: ProtocolDetails -> Encoding

toJSONList :: [ProtocolDetails] -> Value

toEncodingList :: [ProtocolDetails] -> Encoding

Generic ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Associated Types

type Rep ProtocolDetails :: Type -> Type

Methods

from :: ProtocolDetails -> Rep ProtocolDetails x

to :: Rep ProtocolDetails x -> ProtocolDetails

Read ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

readsPrec :: Int -> ReadS ProtocolDetails

readList :: ReadS [ProtocolDetails]

readPrec :: ReadPrec ProtocolDetails

readListPrec :: ReadPrec [ProtocolDetails]

Show ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

showsPrec :: Int -> ProtocolDetails -> ShowS

show :: ProtocolDetails -> String

showList :: [ProtocolDetails] -> ShowS

NFData ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

rnf :: ProtocolDetails -> ()

Eq ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

(==) :: ProtocolDetails -> ProtocolDetails -> Bool

(/=) :: ProtocolDetails -> ProtocolDetails -> Bool

Hashable ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

Methods

hashWithSalt :: Int -> ProtocolDetails -> Int

hash :: ProtocolDetails -> Int

type Rep ProtocolDetails

Defined in Amazonka.Transfer.Types.ProtocolDetails

type Rep ProtocolDetails = D1 ('MetaData "ProtocolDetails" "Amazonka.Transfer.Types.ProtocolDetails" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ProtocolDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "as2Transports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty As2Transport))) :*: S1 ('MetaSel ('Just "passiveIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "setStatOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetStatOption)) :*: S1 ('MetaSel ('Just "tlsSessionResumptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsSessionResumptionMode)))))

newProtocolDetails :: ProtocolDetails

Create a value of ProtocolDetails with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:as2Transports:ProtocolDetails', protocolDetails_as2Transports - Indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

$sel:passiveIp:ProtocolDetails', protocolDetails_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 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.

$sel:setStatOption:ProtocolDetails', protocolDetails_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.

$sel:tlsSessionResumptionMode:ProtocolDetails', protocolDetails_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 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.

protocolDetails_as2Transports :: Lens' ProtocolDetails (Maybe (NonEmpty As2Transport))

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

protocolDetails_passiveIp :: Lens' ProtocolDetails (Maybe Text)

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.

protocolDetails_setStatOption :: Lens' ProtocolDetails (Maybe 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.

protocolDetails_tlsSessionResumptionMode :: Lens' ProtocolDetails (Maybe 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 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.