/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes the properties of a file transfer protocol-enabled server that was
* specified.See Also:
AWS
* API Reference
Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline DescribedServer& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline DescribedServer& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *Specifies the unique Amazon Resource Name (ARN) of the file transfer * protocol-enabled server.
*/ inline DescribedServer& WithArn(const char* value) { SetArn(value); return *this;} /** *Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
* when Protocols is set to FTPS.
Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline const EndpointDetails& GetEndpointDetails() const{ return m_endpointDetails; } /** *Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; } /** *Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline void SetEndpointDetails(const EndpointDetails& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = value; } /** *Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline void SetEndpointDetails(EndpointDetails&& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = std::move(value); } /** *Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline DescribedServer& WithEndpointDetails(const EndpointDetails& value) { SetEndpointDetails(value); return *this;} /** *Specifies the virtual private cloud (VPC) endpoint settings that you * configured for your file transfer protocol-enabled server.
*/ inline DescribedServer& WithEndpointDetails(EndpointDetails&& value) { SetEndpointDetails(std::move(value)); return *this;} /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline const EndpointType& GetEndpointType() const{ return m_endpointType; } /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; } /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline void SetEndpointType(const EndpointType& value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; } /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline void SetEndpointType(EndpointType&& value) { m_endpointTypeHasBeenSet = true; m_endpointType = std::move(value); } /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline DescribedServer& WithEndpointType(const EndpointType& value) { SetEndpointType(value); return *this;} /** *Defines the type of endpoint that your file transfer protocol-enabled server * is connected to. If your server is connected to a VPC endpoint, your server * isn't accessible over the public internet.
*/ inline DescribedServer& WithEndpointType(EndpointType&& value) { SetEndpointType(std::move(value)); return *this;} /** *Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
* This value is equivalent to the output of the ssh-keygen -l -f
* my-new-server-key command.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies information to call a customer-supplied authentication API. This
* field is not populated when the IdentityProviderType of a file
* transfer protocol-enabled server is SERVICE_MANAGED.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the mode of authentication method enabled for this service. A value
* of SERVICE_MANAGED means that you are using this file transfer
* protocol-enabled server to store and access user credentials within the service.
* A value of API_GATEWAY indicates that you have integrated an API
* Gateway endpoint that will be invoked for authenticating your user into the
* service.
Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline const Aws::String& GetLoggingRole() const{ return m_loggingRole; } /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; } /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline void SetLoggingRole(const Aws::String& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = value; } /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline void SetLoggingRole(Aws::String&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::move(value); } /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline void SetLoggingRole(const char* value) { m_loggingRoleHasBeenSet = true; m_loggingRole.assign(value); } /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline DescribedServer& WithLoggingRole(const Aws::String& value) { SetLoggingRole(value); return *this;} /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline DescribedServer& WithLoggingRole(Aws::String&& value) { SetLoggingRole(std::move(value)); return *this;} /** *Specifies the AWS Identity and Access Management (IAM) role that allows a * file transfer protocol-enabled server to turn on Amazon CloudWatch logging for * Amazon S3 events. When set, user activity can be viewed in your CloudWatch * logs.
*/ inline DescribedServer& WithLoggingRole(const char* value) { SetLoggingRole(value); return *this;} /** *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
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
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
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
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
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
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
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
Specifies the name of the security policy that is attached to the server.
*/ inline const Aws::String& GetSecurityPolicyName() const{ return m_securityPolicyName; } /** *Specifies the name of the security policy that is attached to the server.
*/ inline bool SecurityPolicyNameHasBeenSet() const { return m_securityPolicyNameHasBeenSet; } /** *Specifies the name of the security policy that is attached to the server.
*/ inline void SetSecurityPolicyName(const Aws::String& value) { m_securityPolicyNameHasBeenSet = true; m_securityPolicyName = value; } /** *Specifies the name of the security policy that is attached to the server.
*/ inline void SetSecurityPolicyName(Aws::String&& value) { m_securityPolicyNameHasBeenSet = true; m_securityPolicyName = std::move(value); } /** *Specifies the name of the security policy that is attached to the server.
*/ inline void SetSecurityPolicyName(const char* value) { m_securityPolicyNameHasBeenSet = true; m_securityPolicyName.assign(value); } /** *Specifies the name of the security policy that is attached to the server.
*/ inline DescribedServer& WithSecurityPolicyName(const Aws::String& value) { SetSecurityPolicyName(value); return *this;} /** *Specifies the name of the security policy that is attached to the server.
*/ inline DescribedServer& WithSecurityPolicyName(Aws::String&& value) { SetSecurityPolicyName(std::move(value)); return *this;} /** *Specifies the name of the security policy that is attached to the server.
*/ inline DescribedServer& WithSecurityPolicyName(const char* value) { SetSecurityPolicyName(value); return *this;} /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline const Aws::String& GetServerId() const{ return m_serverId; } /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline DescribedServer& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline DescribedServer& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** *Specifies the unique system-assigned identifier for a file transfer * protocol-enabled server that you instantiate.
*/ inline DescribedServer& WithServerId(const char* value) { SetServerId(value); return *this;} /** *Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the condition of a file transfer protocol-enabled server for the
* server that was described. A value of ONLINE indicates that the
* server can accept jobs and transfer files. A State value of
* OFFLINE means that the server cannot perform file transfer
* operations.
The states of STARTING and STOPPING
* indicate that the server is in an intermediate state, either not fully able to
* respond, or not fully offline. The values of START_FAILED or
* STOP_FAILED can indicate an error condition.
Specifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline const Aws::VectorSpecifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *Specifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline void SetTags(const Aws::VectorSpecifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline void SetTags(Aws::VectorSpecifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline DescribedServer& WithTags(const Aws::VectorSpecifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline DescribedServer& WithTags(Aws::VectorSpecifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline DescribedServer& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *Specifies the key-value pairs that you can use to search for and group file * transfer protocol-enabled servers that were assigned to the server that was * described.
*/ inline DescribedServer& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *Specifies the number of users that are assigned to a file transfer
* protocol-enabled server you specified with the ServerId.
Specifies the number of users that are assigned to a file transfer
* protocol-enabled server you specified with the ServerId.
Specifies the number of users that are assigned to a file transfer
* protocol-enabled server you specified with the ServerId.
Specifies the number of users that are assigned to a file transfer
* protocol-enabled server you specified with the ServerId.