software.amazon.awssdk.services.transfer.model

Class DescribedServer

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedServer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedServer.Builder,DescribedServer>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribedServer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedServer.Builder,DescribedServer>

Describes the properties of a file transfer protocol-enabled server that was specified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribedServer.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Specifies the unique Amazon Resource Name (ARN) of the server.
static DescribedServer.Builder	builder()
String	certificate() Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
Domain	domain() Specifies the domain of the storage system that is used for file transfers.
String	domainAsString() Specifies the domain of the storage system that is used for file transfers.
EndpointDetails	endpointDetails() Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
EndpointType	endpointType() Defines the type of endpoint that your server is connected to.
String	endpointTypeAsString() Defines the type of endpoint that your server is connected to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProtocols() Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	hostKeyFingerprint() Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
IdentityProviderDetails	identityProviderDetails() Specifies information to call a customer-supplied authentication API.
IdentityProviderType	identityProviderType() Specifies the mode of authentication method enabled for this service.
String	identityProviderTypeAsString() Specifies the mode of authentication method enabled for this service.
String	loggingRole() Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
List<Protocol>	protocols() Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
List<String>	protocolsAsStrings() Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
List<SdkField<?>>	sdkFields()
String	securityPolicyName() Specifies the name of the security policy that is attached to the server.
static Class<? extends DescribedServer.Builder>	serializableBuilderClass()
String	serverId() Specifies the unique system-assigned identifier for a server that you instantiate.
State	state() Specifies the condition of a server for the server that was described.
String	stateAsString() Specifies the condition of a server for the server that was described.
List<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.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	userCount() Specifies the number of users that are assigned to a server you specified with the ServerId.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

Specifies the unique Amazon Resource Name (ARN) of the server.

Returns:

Specifies the unique Amazon Resource Name (ARN) of the server.

certificate

public final String certificate()

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Returns:

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

domain

public final Domain domain()

Specifies the domain of the storage system that is used for file transfers.

If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

Specifies the domain of the storage system that is used for file transfers.

See Also:

Domain

domainAsString

public final String domainAsString()

Specifies the domain of the storage system that is used for file transfers.

If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

Specifies the domain of the storage system that is used for file transfers.

See Also:

Domain

endpointDetails

public final EndpointDetails endpointDetails()

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

Returns:

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

endpointType

public final 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.

If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

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

endpointTypeAsString

public final String endpointTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().

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

hostKeyFingerprint

public final 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.

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.

identityProviderDetails

public final 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.

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.

identityProviderType

public final IdentityProviderType identityProviderType()

Specifies the mode of authentication method enabled for this service. A value of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that you are using this 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.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

Returns:

Specifies the mode of authentication method enabled for this service. A value of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that you are using this 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.

See Also:

IdentityProviderType

identityProviderTypeAsString

public final String identityProviderTypeAsString()

Specifies the mode of authentication method enabled for this service. A value of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that you are using this 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.

If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().

Returns:

Specifies the mode of authentication method enabled for this service. A value of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that you are using this 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.

See Also:

IdentityProviderType

loggingRole

public final String loggingRole()

Specifies the AWS 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 AWS 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.

protocols

public final List<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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProtocols() to see if a value was sent in this field.

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

hasProtocols

public final boolean hasProtocols()

Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

protocolsAsStrings

public final List<String> protocolsAsStrings()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProtocols() to see if a value was sent in this field.

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

securityPolicyName

public final String securityPolicyName()

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.

serverId

public final String serverId()

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.

state

public final 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.

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

stateAsString

public final String stateAsString()

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.

If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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.

userCount

public final Integer userCount()

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.

toBuilder

public DescribedServer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedServer.Builder,DescribedServer>

builder

public static DescribedServer.Builder builder()

serializableBuilderClass

public static Class<? extends DescribedServer.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo