DescribedServer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedServer

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedServer
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the properties of a file transfer protocol-enabled server that was specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedServer()

Constructors
Constructor and Description
`DescribedServer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedServer`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Specifies the unique Amazon Resource Name (ARN) of the server.
`String`	`getCertificate()` Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`String`	`getDomain()` Specifies the domain of the storage system that is used for file transfers.
`EndpointDetails`	`getEndpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`String`	`getEndpointType()` Defines the type of endpoint that your server is connected to.
`String`	`getHostKeyFingerprint()` Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
`IdentityProviderDetails`	`getIdentityProviderDetails()` Specifies information to call a customer-supplied authentication API.
`String`	`getIdentityProviderType()` Specifies the mode of authentication for a server.
`String`	`getLoggingRole()` 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.
`String`	`getPostAuthenticationLoginBanner()` Specify a string to display when users connect to a server.
`String`	`getPreAuthenticationLoginBanner()` Specify a string to display when users connect to a server.
`ProtocolDetails`	`getProtocolDetails()` The protocol settings that are configured for your server.
`List<String>`	`getProtocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`String`	`getSecurityPolicyName()` Specifies the name of the security policy that is attached to the server.
`String`	`getServerId()` Specifies the unique system-assigned identifier for a server that you instantiate.
`String`	`getState()` Specifies the condition of a server for the server that was described.
`List<Tag>`	`getTags()` Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
`Integer`	`getUserCount()` Specifies the number of users that are assigned to a server you specified with the `ServerId`.
`WorkflowDetails`	`getWorkflowDetails()` Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Specifies the unique Amazon Resource Name (ARN) of the server.
`void`	`setCertificate(String certificate)` Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`void`	`setDomain(String domain)` Specifies the domain of the storage system that is used for file transfers.
`void`	`setEndpointDetails(EndpointDetails endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`void`	`setEndpointType(String endpointType)` Defines the type of endpoint that your server is connected to.
`void`	`setHostKeyFingerprint(String hostKeyFingerprint)` Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
`void`	`setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)` Specifies information to call a customer-supplied authentication API.
`void`	`setIdentityProviderType(String identityProviderType)` Specifies the mode of authentication for a server.
`void`	`setLoggingRole(String loggingRole)` 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.
`void`	`setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)` Specify a string to display when users connect to a server.
`void`	`setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)` Specify a string to display when users connect to a server.
`void`	`setProtocolDetails(ProtocolDetails protocolDetails)` The protocol settings that are configured for your server.
`void`	`setProtocols(Collection<String> protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`void`	`setSecurityPolicyName(String securityPolicyName)` Specifies the name of the security policy that is attached to the server.
`void`	`setServerId(String serverId)` Specifies the unique system-assigned identifier for a server that you instantiate.
`void`	`setState(String state)` Specifies the condition of a server for the server that was described.
`void`	`setTags(Collection<Tag> tags)` Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
`void`	`setUserCount(Integer userCount)` Specifies the number of users that are assigned to a server you specified with the `ServerId`.
`void`	`setWorkflowDetails(WorkflowDetails workflowDetails)` Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
`String`	`toString()` Returns a string representation of this object.
`DescribedServer`	`withArn(String arn)` Specifies the unique Amazon Resource Name (ARN) of the server.
`DescribedServer`	`withCertificate(String certificate)` Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`DescribedServer`	`withDomain(Domain domain)` Specifies the domain of the storage system that is used for file transfers.
`DescribedServer`	`withDomain(String domain)` Specifies the domain of the storage system that is used for file transfers.
`DescribedServer`	`withEndpointDetails(EndpointDetails endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`DescribedServer`	`withEndpointType(EndpointType endpointType)` Defines the type of endpoint that your server is connected to.
`DescribedServer`	`withEndpointType(String endpointType)` Defines the type of endpoint that your server is connected to.
`DescribedServer`	`withHostKeyFingerprint(String hostKeyFingerprint)` Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
`DescribedServer`	`withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)` Specifies information to call a customer-supplied authentication API.
`DescribedServer`	`withIdentityProviderType(IdentityProviderType identityProviderType)` Specifies the mode of authentication for a server.
`DescribedServer`	`withIdentityProviderType(String identityProviderType)` Specifies the mode of authentication for a server.
`DescribedServer`	`withLoggingRole(String loggingRole)` 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.
`DescribedServer`	`withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)` Specify a string to display when users connect to a server.
`DescribedServer`	`withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)` Specify a string to display when users connect to a server.
`DescribedServer`	`withProtocolDetails(ProtocolDetails protocolDetails)` The protocol settings that are configured for your server.
`DescribedServer`	`withProtocols(Collection<String> protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`DescribedServer`	`withProtocols(Protocol... protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`DescribedServer`	`withProtocols(String... protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`DescribedServer`	`withSecurityPolicyName(String securityPolicyName)` Specifies the name of the security policy that is attached to the server.
`DescribedServer`	`withServerId(String serverId)` Specifies the unique system-assigned identifier for a server that you instantiate.
`DescribedServer`	`withState(State state)` Specifies the condition of a server for the server that was described.
`DescribedServer`	`withState(String state)` Specifies the condition of a server for the server that was described.
`DescribedServer`	`withTags(Collection<Tag> tags)` Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
`DescribedServer`	`withTags(Tag... tags)` Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
`DescribedServer`	`withUserCount(Integer userCount)` Specifies the number of users that are assigned to a server you specified with the `ServerId`.
`DescribedServer`	`withWorkflowDetails(WorkflowDetails workflowDetails)` Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedServer
```
public DescribedServer()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Specifies the unique Amazon Resource Name (ARN) of the server.
    
    Parameters:
    
    arn - Specifies the unique Amazon Resource Name (ARN) of the server.
  - getArn
```
public String getArn()
```
    Specifies the unique Amazon Resource Name (ARN) of the server.
    
    Returns:
    
    Specifies the unique Amazon Resource Name (ARN) of the server.
  - withArn
```
public DescribedServer withArn(String arn)
```
    Specifies the unique Amazon Resource Name (ARN) of the server.
    
    Parameters:
    
    arn - Specifies the unique Amazon Resource Name (ARN) of the server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificate
```
public void setCertificate(String certificate)
```
    Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    Parameters:
    
    certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
  - getCertificate
```
public String getCertificate()
```
    Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    Returns:
    
    Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
  - withCertificate
```
public DescribedServer withCertificate(String certificate)
```
    Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    Parameters:
    
    certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocolDetails
```
public void setProtocolDetails(ProtocolDetails protocolDetails)
```
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
    
    Parameters:
    
    protocolDetails - The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
  - getProtocolDetails
```
public ProtocolDetails getProtocolDetails()
```
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
    
    Returns:
    
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
  - withProtocolDetails
```
public DescribedServer withProtocolDetails(ProtocolDetails protocolDetails)
```
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
    
    Parameters:
    
    protocolDetails - The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomain
```
public void setDomain(String domain)
```
    Specifies the domain of the storage system that is used for file transfers.
    
    Parameters:
    
    domain - Specifies the domain of the storage system that is used for file transfers.
    
    See Also:
    
    Domain
  - getDomain
```
public String getDomain()
```
    Specifies the domain of the storage system that is used for file transfers.
    
    Returns:
    
    Specifies the domain of the storage system that is used for file transfers.
    
    See Also:
    
    Domain
  - withDomain
```
public DescribedServer withDomain(String domain)
```
    Specifies the domain of the storage system that is used for file transfers.
    
    Parameters:
    
    domain - Specifies the domain of the storage system that is used for file transfers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Domain
  - withDomain
```
public DescribedServer withDomain(Domain domain)
```
    Specifies the domain of the storage system that is used for file transfers.
    
    Parameters:
    
    domain - Specifies the domain of the storage system that is used for file transfers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Domain
  - setEndpointDetails
```
public void setEndpointDetails(EndpointDetails endpointDetails)
```
    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.
    
    Parameters:
    
    endpointDetails - 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.
  - getEndpointDetails
```
public EndpointDetails getEndpointDetails()
```
    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.
    
    Returns:
    
    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.
  - withEndpointDetails
```
public DescribedServer withEndpointDetails(EndpointDetails endpointDetails)
```
    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.
    
    Parameters:
    
    endpointDetails - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointType
```
public void setEndpointType(String endpointType)
```
    Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    See Also:
    
    EndpointType
  - getEndpointType
```
public String getEndpointType()
```
    Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DescribedServer withEndpointType(String endpointType)
```
    Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public DescribedServer withEndpointType(EndpointType endpointType)
```
    Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Parameters:
    
    endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - setHostKeyFingerprint
```
public void setHostKeyFingerprint(String hostKeyFingerprint)
```
    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.
    
    Parameters:
    
    hostKeyFingerprint - 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.
  - getHostKeyFingerprint
```
public String getHostKeyFingerprint()
```
    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.
    
    Returns:
    
    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.
  - withHostKeyFingerprint
```
public DescribedServer withHostKeyFingerprint(String hostKeyFingerprint)
```
    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.
    
    Parameters:
    
    hostKeyFingerprint - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderDetails
```
public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
```
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
    
    Parameters:
    
    identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
  - getIdentityProviderDetails
```
public IdentityProviderDetails getIdentityProviderDetails()
```
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
    
    Returns:
    
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
  - withIdentityProviderDetails
```
public DescribedServer withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
```
    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
    
    Parameters:
    
    identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderType
```
public void setIdentityProviderType(String identityProviderType)
```
    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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Parameters:
    
    identityProviderType - 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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    See Also:
    
    IdentityProviderType
  - getIdentityProviderType
```
public String getIdentityProviderType()
```
    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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Returns:
    
    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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public DescribedServer withIdentityProviderType(String identityProviderType)
```
    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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Parameters:
    
    identityProviderType - 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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - withIdentityProviderType
```
public DescribedServer withIdentityProviderType(IdentityProviderType identityProviderType)
```
    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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Parameters:
    
    identityProviderType - 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.
    
    Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value, you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IdentityProviderType
  - setLoggingRole
```
public void setLoggingRole(String loggingRole)
```
    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.
    
    Parameters:
    
    loggingRole - 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.
  - getLoggingRole
```
public String getLoggingRole()
```
    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.
    
    Returns:
    
    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.
  - withLoggingRole
```
public DescribedServer withLoggingRole(String loggingRole)
```
    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.
    
    Parameters:
    
    loggingRole - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPostAuthenticationLoginBanner
```
public void setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
```
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
    
    Parameters:
    
    postAuthenticationLoginBanner - Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
  - getPostAuthenticationLoginBanner
```
public String getPostAuthenticationLoginBanner()
```
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
    
    Returns:
    
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
  - withPostAuthenticationLoginBanner
```
public DescribedServer withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
```
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
    
    Parameters:
    
    postAuthenticationLoginBanner - Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreAuthenticationLoginBanner
```
public void setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
```
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
    
    Parameters:
    
    preAuthenticationLoginBanner - Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
  - getPreAuthenticationLoginBanner
```
public String getPreAuthenticationLoginBanner()
```
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
    
    Returns:
    
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
  - withPreAuthenticationLoginBanner
```
public DescribedServer withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
```
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
    
    Parameters:
    
    preAuthenticationLoginBanner - Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProtocols
```
public List<String> getProtocols()
```
    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
    Returns:
    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
    See Also:
    
    Protocol
  - setProtocols
```
public void setProtocols(Collection<String> protocols)
```
    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
    Parameters:
    protocols - 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
    See Also:
    
    Protocol
  - withProtocols
```
public DescribedServer withProtocols(String... protocols)
```
    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
    NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.
    Parameters:
    protocols - 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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - withProtocols
```
public DescribedServer withProtocols(Collection<String> protocols)
```
    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
    Parameters:
    protocols - 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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - withProtocols
```
public DescribedServer withProtocols(Protocol... protocols)
```
    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
    Parameters:
    protocols - 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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - setSecurityPolicyName
```
public void setSecurityPolicyName(String securityPolicyName)
```
    Specifies the name of the security policy that is attached to the server.
    
    Parameters:
    
    securityPolicyName - Specifies the name of the security policy that is attached to the server.
  - getSecurityPolicyName
```
public String getSecurityPolicyName()
```
    Specifies the name of the security policy that is attached to the server.
    
    Returns:
    
    Specifies the name of the security policy that is attached to the server.
  - withSecurityPolicyName
```
public DescribedServer withSecurityPolicyName(String securityPolicyName)
```
    Specifies the name of the security policy that is attached to the server.
    
    Parameters:
    
    securityPolicyName - Specifies the name of the security policy that is attached to the server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerId
```
public void setServerId(String serverId)
```
    Specifies the unique system-assigned identifier for a server that you instantiate.
    
    Parameters:
    
    serverId - Specifies the unique system-assigned identifier for a server that you instantiate.
  - getServerId
```
public String getServerId()
```
    Specifies the unique system-assigned identifier for a server that you instantiate.
    
    Returns:
    
    Specifies the unique system-assigned identifier for a server that you instantiate.
  - withServerId
```
public DescribedServer withServerId(String serverId)
```
    Specifies the unique system-assigned identifier for a server that you instantiate.
    
    Parameters:
    
    serverId - Specifies the unique system-assigned identifier for a server that you instantiate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Specifies the condition of a 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.
    
    Parameters:
    
    state - Specifies the condition of a 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.
    
    See Also:
    
    State
  - getState
```
public String getState()
```
    Specifies the condition of a 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.
    
    Returns:
    
    Specifies the condition of a 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.
    
    See Also:
    
    State
  - withState
```
public DescribedServer withState(String state)
```
    Specifies the condition of a 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.
    
    Parameters:
    
    state - Specifies the condition of a 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    State
  - withState
```
public DescribedServer withState(State state)
```
    Specifies the condition of a 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.
    
    Parameters:
    
    state - Specifies the condition of a 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    State
  - getTags
```
public List<Tag> getTags()
```
    Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Returns:
    
    Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Parameters:
    
    tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
  - withTags
```
public DescribedServer withTags(Tag... tags)
```
    Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribedServer withTags(Collection<Tag> tags)
```
    Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Parameters:
    
    tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserCount
```
public void setUserCount(Integer userCount)
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Parameters:
    
    userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
  - getUserCount
```
public Integer getUserCount()
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Returns:
    
    Specifies the number of users that are assigned to a server you specified with the ServerId.
  - withUserCount
```
public DescribedServer withUserCount(Integer userCount)
```
    Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Parameters:
    
    userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkflowDetails
```
public void setWorkflowDetails(WorkflowDetails workflowDetails)
```
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    Parameters:
    
    workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
  - getWorkflowDetails
```
public WorkflowDetails getWorkflowDetails()
```
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    Returns:
    
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
  - withWorkflowDetails
```
public DescribedServer withWorkflowDetails(WorkflowDetails workflowDetails)
```
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    Parameters:
    
    workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribedServer clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DescribedServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedServer

Method Detail

setArn

getArn

withArn

setCertificate

getCertificate

withCertificate

setProtocolDetails

getProtocolDetails

withProtocolDetails

setDomain

getDomain

withDomain

withDomain

setEndpointDetails

getEndpointDetails

withEndpointDetails

setEndpointType

getEndpointType

withEndpointType

withEndpointType

setHostKeyFingerprint

getHostKeyFingerprint

withHostKeyFingerprint

setIdentityProviderDetails

getIdentityProviderDetails

withIdentityProviderDetails

setIdentityProviderType

getIdentityProviderType

withIdentityProviderType

withIdentityProviderType

setLoggingRole

getLoggingRole

withLoggingRole

setPostAuthenticationLoginBanner

getPostAuthenticationLoginBanner

withPostAuthenticationLoginBanner

setPreAuthenticationLoginBanner

getPreAuthenticationLoginBanner

withPreAuthenticationLoginBanner

getProtocols

setProtocols

withProtocols

withProtocols

withProtocols

setSecurityPolicyName

getSecurityPolicyName

withSecurityPolicyName

setServerId

getServerId

withServerId

setState

getState

withState

withState

getTags

setTags

withTags

withTags

setUserCount

getUserCount

withUserCount

setWorkflowDetails

getWorkflowDetails

withWorkflowDetails

toString

equals

hashCode

clone

marshall