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

#include <CreateServerRequest.h>

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

Public Member Functions

 CreateServerRequest ()
 
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)
 
CreateServerRequestWithCertificate (const Aws::String &value)
 
CreateServerRequestWithCertificate (Aws::String &&value)
 
CreateServerRequestWithCertificate (const char *value)
 
const DomainGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Domain &value)
 
void SetDomain (Domain &&value)
 
CreateServerRequestWithDomain (const Domain &value)
 
CreateServerRequestWithDomain (Domain &&value)
 
const EndpointDetailsGetEndpointDetails () const
 
bool EndpointDetailsHasBeenSet () const
 
void SetEndpointDetails (const EndpointDetails &value)
 
void SetEndpointDetails (EndpointDetails &&value)
 
CreateServerRequestWithEndpointDetails (const EndpointDetails &value)
 
CreateServerRequestWithEndpointDetails (EndpointDetails &&value)
 
const EndpointTypeGetEndpointType () const
 
bool EndpointTypeHasBeenSet () const
 
void SetEndpointType (const EndpointType &value)
 
void SetEndpointType (EndpointType &&value)
 
CreateServerRequestWithEndpointType (const EndpointType &value)
 
CreateServerRequestWithEndpointType (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)
 
CreateServerRequestWithHostKey (const Aws::String &value)
 
CreateServerRequestWithHostKey (Aws::String &&value)
 
CreateServerRequestWithHostKey (const char *value)
 
const IdentityProviderDetailsGetIdentityProviderDetails () const
 
bool IdentityProviderDetailsHasBeenSet () const
 
void SetIdentityProviderDetails (const IdentityProviderDetails &value)
 
void SetIdentityProviderDetails (IdentityProviderDetails &&value)
 
CreateServerRequestWithIdentityProviderDetails (const IdentityProviderDetails &value)
 
CreateServerRequestWithIdentityProviderDetails (IdentityProviderDetails &&value)
 
const IdentityProviderTypeGetIdentityProviderType () const
 
bool IdentityProviderTypeHasBeenSet () const
 
void SetIdentityProviderType (const IdentityProviderType &value)
 
void SetIdentityProviderType (IdentityProviderType &&value)
 
CreateServerRequestWithIdentityProviderType (const IdentityProviderType &value)
 
CreateServerRequestWithIdentityProviderType (IdentityProviderType &&value)
 
const Aws::StringGetLoggingRole () const
 
bool LoggingRoleHasBeenSet () const
 
void SetLoggingRole (const Aws::String &value)
 
void SetLoggingRole (Aws::String &&value)
 
void SetLoggingRole (const char *value)
 
CreateServerRequestWithLoggingRole (const Aws::String &value)
 
CreateServerRequestWithLoggingRole (Aws::String &&value)
 
CreateServerRequestWithLoggingRole (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)
 
CreateServerRequestWithProtocols (const Aws::Vector< Protocol > &value)
 
CreateServerRequestWithProtocols (Aws::Vector< Protocol > &&value)
 
CreateServerRequestAddProtocols (const Protocol &value)
 
CreateServerRequestAddProtocols (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)
 
CreateServerRequestWithSecurityPolicyName (const Aws::String &value)
 
CreateServerRequestWithSecurityPolicyName (Aws::String &&value)
 
CreateServerRequestWithSecurityPolicyName (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateServerRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateServerRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateServerRequestAddTags (const Tag &value)
 
CreateServerRequestAddTags (Tag &&value)
 
const WorkflowDetailsGetWorkflowDetails () const
 
bool WorkflowDetailsHasBeenSet () const
 
void SetWorkflowDetails (const WorkflowDetails &value)
 
void SetWorkflowDetails (WorkflowDetails &&value)
 
CreateServerRequestWithWorkflowDetails (const WorkflowDetails &value)
 
CreateServerRequestWithWorkflowDetails (WorkflowDetails &&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 30 of file CreateServerRequest.h.

Constructor & Destructor Documentation

◆ CreateServerRequest()

Aws::Transfer::Model::CreateServerRequest::CreateServerRequest ( )

Member Function Documentation

◆ AddProtocols() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 961 of file CreateServerRequest.h.

◆ AddProtocols() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 984 of file CreateServerRequest.h.

◆ AddTags() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::AddTags ( const Tag value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1061 of file CreateServerRequest.h.

◆ AddTags() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::AddTags ( Tag &&  value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1066 of file CreateServerRequest.h.

◆ CertificateHasBeenSet()

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 92 of file CreateServerRequest.h.

◆ DomainHasBeenSet()

bool Aws::Transfer::Model::CreateServerRequest::DomainHasBeenSet ( ) const
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 253 of file CreateServerRequest.h.

◆ EndpointDetailsHasBeenSet()

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 304 of file CreateServerRequest.h.

◆ EndpointTypeHasBeenSet()

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 387 of file CreateServerRequest.h.

◆ GetCertificate()

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 68 of file CreateServerRequest.h.

◆ GetDomain()

const Domain& Aws::Transfer::Model::CreateServerRequest::GetDomain ( ) const
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 245 of file CreateServerRequest.h.

◆ GetEndpointDetails()

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 295 of file CreateServerRequest.h.

◆ GetEndpointType()

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 364 of file CreateServerRequest.h.

◆ GetHostKey()

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 492 of file CreateServerRequest.h.

◆ GetIdentityProviderDetails()

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 587 of file CreateServerRequest.h.

◆ GetIdentityProviderType()

const IdentityProviderType& Aws::Transfer::Model::CreateServerRequest::GetIdentityProviderType ( ) const
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 654 of file CreateServerRequest.h.

◆ GetLoggingRole()

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 743 of file CreateServerRequest.h.

◆ GetProtocols()

const Aws::Vector<Protocol>& Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 823 of file CreateServerRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetSecurityPolicyName()

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

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

Definition at line 990 of file CreateServerRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file CreateServerRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Transfer::Model::CreateServerRequest::GetTags ( ) const
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1031 of file CreateServerRequest.h.

◆ GetWorkflowDetails()

const WorkflowDetails& Aws::Transfer::Model::CreateServerRequest::GetWorkflowDetails ( ) const
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1073 of file CreateServerRequest.h.

◆ HostKeyHasBeenSet()

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 504 of file CreateServerRequest.h.

◆ IdentityProviderDetailsHasBeenSet()

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 597 of file CreateServerRequest.h.

◆ IdentityProviderTypeHasBeenSet()

bool Aws::Transfer::Model::CreateServerRequest::IdentityProviderTypeHasBeenSet ( ) const
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 670 of file CreateServerRequest.h.

◆ LoggingRoleHasBeenSet()

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 751 of file CreateServerRequest.h.

◆ ProtocolsHasBeenSet()

bool Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 846 of file CreateServerRequest.h.

◆ SecurityPolicyNameHasBeenSet()

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

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

Definition at line 995 of file CreateServerRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCertificate() [1/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 140 of file CreateServerRequest.h.

◆ SetCertificate() [2/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 116 of file CreateServerRequest.h.

◆ SetCertificate() [3/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 164 of file CreateServerRequest.h.

◆ SetDomain() [1/2]

void Aws::Transfer::Model::CreateServerRequest::SetDomain ( const Domain value)
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 261 of file CreateServerRequest.h.

◆ SetDomain() [2/2]

void Aws::Transfer::Model::CreateServerRequest::SetDomain ( Domain &&  value)
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 269 of file CreateServerRequest.h.

◆ SetEndpointDetails() [1/2]

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 313 of file CreateServerRequest.h.

◆ SetEndpointDetails() [2/2]

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 322 of file CreateServerRequest.h.

◆ SetEndpointType() [1/2]

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 410 of file CreateServerRequest.h.

◆ SetEndpointType() [2/2]

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 433 of file CreateServerRequest.h.

◆ SetHostKey() [1/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 528 of file CreateServerRequest.h.

◆ SetHostKey() [2/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 516 of file CreateServerRequest.h.

◆ SetHostKey() [3/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 540 of file CreateServerRequest.h.

◆ SetIdentityProviderDetails() [1/2]

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 607 of file CreateServerRequest.h.

◆ SetIdentityProviderDetails() [2/2]

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 617 of file CreateServerRequest.h.

◆ SetIdentityProviderType() [1/2]

void Aws::Transfer::Model::CreateServerRequest::SetIdentityProviderType ( const IdentityProviderType value)
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 686 of file CreateServerRequest.h.

◆ SetIdentityProviderType() [2/2]

void Aws::Transfer::Model::CreateServerRequest::SetIdentityProviderType ( IdentityProviderType &&  value)
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 702 of file CreateServerRequest.h.

◆ SetLoggingRole() [1/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 767 of file CreateServerRequest.h.

◆ SetLoggingRole() [2/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 759 of file CreateServerRequest.h.

◆ SetLoggingRole() [3/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 775 of file CreateServerRequest.h.

◆ SetProtocols() [1/2]

void Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 892 of file CreateServerRequest.h.

◆ SetProtocols() [2/2]

void Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 869 of file CreateServerRequest.h.

◆ SetSecurityPolicyName() [1/3]

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

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

Definition at line 1005 of file CreateServerRequest.h.

◆ SetSecurityPolicyName() [2/3]

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

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

Definition at line 1000 of file CreateServerRequest.h.

◆ SetSecurityPolicyName() [3/3]

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

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

Definition at line 1010 of file CreateServerRequest.h.

◆ SetTags() [1/2]

void Aws::Transfer::Model::CreateServerRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1046 of file CreateServerRequest.h.

◆ SetTags() [2/2]

void Aws::Transfer::Model::CreateServerRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1041 of file CreateServerRequest.h.

◆ SetWorkflowDetails() [1/2]

void Aws::Transfer::Model::CreateServerRequest::SetWorkflowDetails ( const WorkflowDetails value)
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1085 of file CreateServerRequest.h.

◆ SetWorkflowDetails() [2/2]

void Aws::Transfer::Model::CreateServerRequest::SetWorkflowDetails ( WorkflowDetails &&  value)
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1091 of file CreateServerRequest.h.

◆ TagsHasBeenSet()

bool Aws::Transfer::Model::CreateServerRequest::TagsHasBeenSet ( ) const
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1036 of file CreateServerRequest.h.

◆ WithCertificate() [1/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 212 of file CreateServerRequest.h.

◆ WithCertificate() [2/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 188 of file CreateServerRequest.h.

◆ WithCertificate() [3/3]

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

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

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

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

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services 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 236 of file CreateServerRequest.h.

◆ WithDomain() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithDomain ( const Domain value)
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 277 of file CreateServerRequest.h.

◆ WithDomain() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithDomain ( Domain &&  value)
inline

The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

After the server is created, the domain cannot be changed.

Definition at line 285 of file CreateServerRequest.h.

◆ WithEndpointDetails() [1/2]

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 331 of file CreateServerRequest.h.

◆ WithEndpointDetails() [2/2]

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

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Definition at line 340 of file CreateServerRequest.h.

◆ WithEndpointType() [1/2]

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 456 of file CreateServerRequest.h.

◆ WithEndpointType() [2/2]

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

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

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 479 of file CreateServerRequest.h.

◆ WithHostKey() [1/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 564 of file CreateServerRequest.h.

◆ WithHostKey() [2/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 552 of file CreateServerRequest.h.

◆ WithHostKey() [3/3]

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

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

If you aren't planning to migrate existing users from an existing SFTP-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 Amazon Web Services Transfer Family User Guide.

Definition at line 576 of file CreateServerRequest.h.

◆ WithIdentityProviderDetails() [1/2]

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 627 of file CreateServerRequest.h.

◆ WithIdentityProviderDetails() [2/2]

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

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Definition at line 637 of file CreateServerRequest.h.

◆ WithIdentityProviderType() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithIdentityProviderType ( const IdentityProviderType value)
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 718 of file CreateServerRequest.h.

◆ WithIdentityProviderType() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithIdentityProviderType ( IdentityProviderType &&  value)
inline

Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Definition at line 734 of file CreateServerRequest.h.

◆ WithLoggingRole() [1/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 791 of file CreateServerRequest.h.

◆ WithLoggingRole() [2/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 783 of file CreateServerRequest.h.

◆ WithLoggingRole() [3/3]

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

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.

Definition at line 799 of file CreateServerRequest.h.

◆ WithProtocols() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 938 of file CreateServerRequest.h.

◆ WithProtocols() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::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:

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

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

  • FTP (File Transfer Protocol): Unencrypted file transfer

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is 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 AWS_DIRECTORY_SERVICE or 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 915 of file CreateServerRequest.h.

◆ WithSecurityPolicyName() [1/3]

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

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

Definition at line 1020 of file CreateServerRequest.h.

◆ WithSecurityPolicyName() [2/3]

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

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

Definition at line 1015 of file CreateServerRequest.h.

◆ WithSecurityPolicyName() [3/3]

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

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

Definition at line 1025 of file CreateServerRequest.h.

◆ WithTags() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1056 of file CreateServerRequest.h.

◆ WithTags() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs that can be used to group and search for servers.

Definition at line 1051 of file CreateServerRequest.h.

◆ WithWorkflowDetails() [1/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithWorkflowDetails ( const WorkflowDetails value)
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1097 of file CreateServerRequest.h.

◆ WithWorkflowDetails() [2/2]

CreateServerRequest& Aws::Transfer::Model::CreateServerRequest::WithWorkflowDetails ( WorkflowDetails &&  value)
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1103 of file CreateServerRequest.h.

◆ WorkflowDetailsHasBeenSet()

bool Aws::Transfer::Model::CreateServerRequest::WorkflowDetailsHasBeenSet ( ) const
inline

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Definition at line 1079 of file CreateServerRequest.h.


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