AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::UpdateServerRequest Class Reference

#include <UpdateServerRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::UpdateServerRequest:

Public Member Functions

 UpdateServerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCertificate () const
 
bool CertificateHasBeenSet () const
 
void SetCertificate (const Aws::String &value)
 
void SetCertificate (Aws::String &&value)
 
void SetCertificate (const char *value)
 
UpdateServerRequestWithCertificate (const Aws::String &value)
 
UpdateServerRequestWithCertificate (Aws::String &&value)
 
UpdateServerRequestWithCertificate (const char *value)
 
const EndpointDetailsGetEndpointDetails () const
 
bool EndpointDetailsHasBeenSet () const
 
void SetEndpointDetails (const EndpointDetails &value)
 
void SetEndpointDetails (EndpointDetails &&value)
 
UpdateServerRequestWithEndpointDetails (const EndpointDetails &value)
 
UpdateServerRequestWithEndpointDetails (EndpointDetails &&value)
 
const EndpointTypeGetEndpointType () const
 
bool EndpointTypeHasBeenSet () const
 
void SetEndpointType (const EndpointType &value)
 
void SetEndpointType (EndpointType &&value)
 
UpdateServerRequestWithEndpointType (const EndpointType &value)
 
UpdateServerRequestWithEndpointType (EndpointType &&value)
 
const Aws::StringGetHostKey () const
 
bool HostKeyHasBeenSet () const
 
void SetHostKey (const Aws::String &value)
 
void SetHostKey (Aws::String &&value)
 
void SetHostKey (const char *value)
 
UpdateServerRequestWithHostKey (const Aws::String &value)
 
UpdateServerRequestWithHostKey (Aws::String &&value)
 
UpdateServerRequestWithHostKey (const char *value)
 
const IdentityProviderDetailsGetIdentityProviderDetails () const
 
bool IdentityProviderDetailsHasBeenSet () const
 
void SetIdentityProviderDetails (const IdentityProviderDetails &value)
 
void SetIdentityProviderDetails (IdentityProviderDetails &&value)
 
UpdateServerRequestWithIdentityProviderDetails (const IdentityProviderDetails &value)
 
UpdateServerRequestWithIdentityProviderDetails (IdentityProviderDetails &&value)
 
const Aws::StringGetLoggingRole () const
 
bool LoggingRoleHasBeenSet () const
 
void SetLoggingRole (const Aws::String &value)
 
void SetLoggingRole (Aws::String &&value)
 
void SetLoggingRole (const char *value)
 
UpdateServerRequestWithLoggingRole (const Aws::String &value)
 
UpdateServerRequestWithLoggingRole (Aws::String &&value)
 
UpdateServerRequestWithLoggingRole (const char *value)
 
const Aws::Vector< Protocol > & GetProtocols () const
 
bool ProtocolsHasBeenSet () const
 
void SetProtocols (const Aws::Vector< Protocol > &value)
 
void SetProtocols (Aws::Vector< Protocol > &&value)
 
UpdateServerRequestWithProtocols (const Aws::Vector< Protocol > &value)
 
UpdateServerRequestWithProtocols (Aws::Vector< Protocol > &&value)
 
UpdateServerRequestAddProtocols (const Protocol &value)
 
UpdateServerRequestAddProtocols (Protocol &&value)
 
const Aws::StringGetSecurityPolicyName () const
 
bool SecurityPolicyNameHasBeenSet () const
 
void SetSecurityPolicyName (const Aws::String &value)
 
void SetSecurityPolicyName (Aws::String &&value)
 
void SetSecurityPolicyName (const char *value)
 
UpdateServerRequestWithSecurityPolicyName (const Aws::String &value)
 
UpdateServerRequestWithSecurityPolicyName (Aws::String &&value)
 
UpdateServerRequestWithSecurityPolicyName (const char *value)
 
const Aws::StringGetServerId () const
 
bool ServerIdHasBeenSet () const
 
void SetServerId (const Aws::String &value)
 
void SetServerId (Aws::String &&value)
 
void SetServerId (const char *value)
 
UpdateServerRequestWithServerId (const Aws::String &value)
 
UpdateServerRequestWithServerId (Aws::String &&value)
 
UpdateServerRequestWithServerId (const char *value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
virtual ~TransferRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file UpdateServerRequest.h.

Constructor & Destructor Documentation

◆ UpdateServerRequest()

Aws::Transfer::Model::UpdateServerRequest::UpdateServerRequest ( )

Member Function Documentation

◆ AddProtocols() [1/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::AddProtocols ( const Protocol value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 697 of file UpdateServerRequest.h.

◆ AddProtocols() [2/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::AddProtocols ( Protocol &&  value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 718 of file UpdateServerRequest.h.

◆ CertificateHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::CertificateHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 88 of file UpdateServerRequest.h.

◆ EndpointDetailsHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::EndpointDetailsHasBeenSet ( ) const
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 251 of file UpdateServerRequest.h.

◆ EndpointTypeHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::EndpointTypeHasBeenSet ( ) const
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 314 of file UpdateServerRequest.h.

◆ GetCertificate()

const Aws::String& Aws::Transfer::Model::UpdateServerRequest::GetCertificate ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 64 of file UpdateServerRequest.h.

◆ GetEndpointDetails()

const EndpointDetails& Aws::Transfer::Model::UpdateServerRequest::GetEndpointDetails ( ) const
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 242 of file UpdateServerRequest.h.

◆ GetEndpointType()

const EndpointType& Aws::Transfer::Model::UpdateServerRequest::GetEndpointType ( ) const
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 301 of file UpdateServerRequest.h.

◆ GetHostKey()

const Aws::String& Aws::Transfer::Model::UpdateServerRequest::GetHostKey ( ) const
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 379 of file UpdateServerRequest.h.

◆ GetIdentityProviderDetails()

const IdentityProviderDetails& Aws::Transfer::Model::UpdateServerRequest::GetIdentityProviderDetails ( ) const
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 470 of file UpdateServerRequest.h.

◆ GetLoggingRole()

const Aws::String& Aws::Transfer::Model::UpdateServerRequest::GetLoggingRole ( ) const
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 507 of file UpdateServerRequest.h.

◆ GetProtocols()

const Aws::Vector<Protocol>& Aws::Transfer::Model::UpdateServerRequest::GetProtocols ( ) const
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 571 of file UpdateServerRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::UpdateServerRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetSecurityPolicyName()

const Aws::String& Aws::Transfer::Model::UpdateServerRequest::GetSecurityPolicyName ( ) const
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 724 of file UpdateServerRequest.h.

◆ GetServerId()

const Aws::String& Aws::Transfer::Model::UpdateServerRequest::GetServerId ( ) const
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 766 of file UpdateServerRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::UpdateServerRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file UpdateServerRequest.h.

◆ HostKeyHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::HostKeyHasBeenSet ( ) const
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 391 of file UpdateServerRequest.h.

◆ IdentityProviderDetailsHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::IdentityProviderDetailsHasBeenSet ( ) const
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 476 of file UpdateServerRequest.h.

◆ LoggingRoleHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::LoggingRoleHasBeenSet ( ) const
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 513 of file UpdateServerRequest.h.

◆ ProtocolsHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::ProtocolsHasBeenSet ( ) const
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 592 of file UpdateServerRequest.h.

◆ SecurityPolicyNameHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::SecurityPolicyNameHasBeenSet ( ) const
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 729 of file UpdateServerRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::UpdateServerRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerIdHasBeenSet()

bool Aws::Transfer::Model::UpdateServerRequest::ServerIdHasBeenSet ( ) const
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 772 of file UpdateServerRequest.h.

◆ SetCertificate() [1/3]

void Aws::Transfer::Model::UpdateServerRequest::SetCertificate ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 112 of file UpdateServerRequest.h.

◆ SetCertificate() [2/3]

void Aws::Transfer::Model::UpdateServerRequest::SetCertificate ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 136 of file UpdateServerRequest.h.

◆ SetCertificate() [3/3]

void Aws::Transfer::Model::UpdateServerRequest::SetCertificate ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 160 of file UpdateServerRequest.h.

◆ SetEndpointDetails() [1/2]

void Aws::Transfer::Model::UpdateServerRequest::SetEndpointDetails ( const EndpointDetails value)
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 260 of file UpdateServerRequest.h.

◆ SetEndpointDetails() [2/2]

void Aws::Transfer::Model::UpdateServerRequest::SetEndpointDetails ( EndpointDetails &&  value)
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 269 of file UpdateServerRequest.h.

◆ SetEndpointType() [1/2]

void Aws::Transfer::Model::UpdateServerRequest::SetEndpointType ( const EndpointType value)
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 327 of file UpdateServerRequest.h.

◆ SetEndpointType() [2/2]

void Aws::Transfer::Model::UpdateServerRequest::SetEndpointType ( EndpointType &&  value)
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 340 of file UpdateServerRequest.h.

◆ SetHostKey() [1/3]

void Aws::Transfer::Model::UpdateServerRequest::SetHostKey ( const Aws::String value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 403 of file UpdateServerRequest.h.

◆ SetHostKey() [2/3]

void Aws::Transfer::Model::UpdateServerRequest::SetHostKey ( Aws::String &&  value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 415 of file UpdateServerRequest.h.

◆ SetHostKey() [3/3]

void Aws::Transfer::Model::UpdateServerRequest::SetHostKey ( const char *  value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 427 of file UpdateServerRequest.h.

◆ SetIdentityProviderDetails() [1/2]

void Aws::Transfer::Model::UpdateServerRequest::SetIdentityProviderDetails ( const IdentityProviderDetails value)
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 482 of file UpdateServerRequest.h.

◆ SetIdentityProviderDetails() [2/2]

void Aws::Transfer::Model::UpdateServerRequest::SetIdentityProviderDetails ( IdentityProviderDetails &&  value)
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 488 of file UpdateServerRequest.h.

◆ SetLoggingRole() [1/3]

void Aws::Transfer::Model::UpdateServerRequest::SetLoggingRole ( const Aws::String value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 519 of file UpdateServerRequest.h.

◆ SetLoggingRole() [2/3]

void Aws::Transfer::Model::UpdateServerRequest::SetLoggingRole ( Aws::String &&  value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 525 of file UpdateServerRequest.h.

◆ SetLoggingRole() [3/3]

void Aws::Transfer::Model::UpdateServerRequest::SetLoggingRole ( const char *  value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 531 of file UpdateServerRequest.h.

◆ SetProtocols() [1/2]

void Aws::Transfer::Model::UpdateServerRequest::SetProtocols ( const Aws::Vector< Protocol > &  value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 613 of file UpdateServerRequest.h.

◆ SetProtocols() [2/2]

void Aws::Transfer::Model::UpdateServerRequest::SetProtocols ( Aws::Vector< Protocol > &&  value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 634 of file UpdateServerRequest.h.

◆ SetSecurityPolicyName() [1/3]

void Aws::Transfer::Model::UpdateServerRequest::SetSecurityPolicyName ( const Aws::String value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 734 of file UpdateServerRequest.h.

◆ SetSecurityPolicyName() [2/3]

void Aws::Transfer::Model::UpdateServerRequest::SetSecurityPolicyName ( Aws::String &&  value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 739 of file UpdateServerRequest.h.

◆ SetSecurityPolicyName() [3/3]

void Aws::Transfer::Model::UpdateServerRequest::SetSecurityPolicyName ( const char *  value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 744 of file UpdateServerRequest.h.

◆ SetServerId() [1/3]

void Aws::Transfer::Model::UpdateServerRequest::SetServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 778 of file UpdateServerRequest.h.

◆ SetServerId() [2/3]

void Aws::Transfer::Model::UpdateServerRequest::SetServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 784 of file UpdateServerRequest.h.

◆ SetServerId() [3/3]

void Aws::Transfer::Model::UpdateServerRequest::SetServerId ( const char *  value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 790 of file UpdateServerRequest.h.

◆ WithCertificate() [1/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithCertificate ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 184 of file UpdateServerRequest.h.

◆ WithCertificate() [2/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithCertificate ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 208 of file UpdateServerRequest.h.

◆ WithCertificate() [3/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithCertificate ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.

Certificates with the following cryptographic algorithms and key sizes are supported:

  • 2048-bit RSA (RSA_2048)

  • 4096-bit RSA (RSA_4096)

  • Elliptic Prime Curve 256 bit (EC_prime256v1)

  • Elliptic Prime Curve 384 bit (EC_secp384r1)

  • Elliptic Prime Curve 521 bit (EC_secp521r1)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

Definition at line 232 of file UpdateServerRequest.h.

◆ WithEndpointDetails() [1/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithEndpointDetails ( const EndpointDetails value)
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 278 of file UpdateServerRequest.h.

◆ WithEndpointDetails() [2/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithEndpointDetails ( EndpointDetails &&  value)
inline

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Definition at line 287 of file UpdateServerRequest.h.

◆ WithEndpointType() [1/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithEndpointType ( const EndpointType value)
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 353 of file UpdateServerRequest.h.

◆ WithEndpointType() [2/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithEndpointType ( EndpointType &&  value)
inline

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.

Definition at line 366 of file UpdateServerRequest.h.

◆ WithHostKey() [1/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithHostKey ( const Aws::String value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 439 of file UpdateServerRequest.h.

◆ WithHostKey() [2/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithHostKey ( Aws::String &&  value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 451 of file UpdateServerRequest.h.

◆ WithHostKey() [3/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithHostKey ( const char *  value)
inline

The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.

Definition at line 463 of file UpdateServerRequest.h.

◆ WithIdentityProviderDetails() [1/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithIdentityProviderDetails ( const IdentityProviderDetails value)
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 494 of file UpdateServerRequest.h.

◆ WithIdentityProviderDetails() [2/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithIdentityProviderDetails ( IdentityProviderDetails &&  value)
inline

An array containing all of the information required to call a customer's authentication API method.

Definition at line 500 of file UpdateServerRequest.h.

◆ WithLoggingRole() [1/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithLoggingRole ( const Aws::String value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 537 of file UpdateServerRequest.h.

◆ WithLoggingRole() [2/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithLoggingRole ( Aws::String &&  value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 543 of file UpdateServerRequest.h.

◆ WithLoggingRole() [3/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithLoggingRole ( const char *  value)
inline

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Definition at line 549 of file UpdateServerRequest.h.

◆ WithProtocols() [1/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithProtocols ( const Aws::Vector< Protocol > &  value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 655 of file UpdateServerRequest.h.

◆ WithProtocols() [2/2]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithProtocols ( Aws::Vector< Protocol > &&  value)
inline

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

  • File Transfer Protocol (FTP): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY.

If Protocol includes FTP, then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.

Definition at line 676 of file UpdateServerRequest.h.

◆ WithSecurityPolicyName() [1/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithSecurityPolicyName ( const Aws::String value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 749 of file UpdateServerRequest.h.

◆ WithSecurityPolicyName() [2/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithSecurityPolicyName ( Aws::String &&  value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 754 of file UpdateServerRequest.h.

◆ WithSecurityPolicyName() [3/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithSecurityPolicyName ( const char *  value)
inline

Specifies the name of the security policy that is attached to the server.

Definition at line 759 of file UpdateServerRequest.h.

◆ WithServerId() [1/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 796 of file UpdateServerRequest.h.

◆ WithServerId() [2/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 802 of file UpdateServerRequest.h.

◆ WithServerId() [3/3]

UpdateServerRequest& Aws::Transfer::Model::UpdateServerRequest::WithServerId ( const char *  value)
inline

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

Definition at line 808 of file UpdateServerRequest.h.


The documentation for this class was generated from the following file: