@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.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribedServer.Builder |
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()
Returns the value of the Domain property for this object.
|
String |
domainAsString()
Returns the value of the Domain property for this object.
|
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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 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()
Take this object and create a builder that contains all of the current property values of this object.
|
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 . |
copy
public final String arn()
Specifies the unique Amazon Resource Name (ARN) of the server.
public final String certificate()
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols
is set
to FTPS
.
Protocols
is set to FTPS
.public final Domain domain()
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()
.
Domain
public final String domainAsString()
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()
.
Domain
public final EndpointDetails endpointDetails()
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
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()
.
EndpointType
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()
.
EndpointType
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.
ssh-keygen -l -f my-new-server-key
command.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 SERVICE_MANAGED
.
IdentityProviderType
of a server is SERVICE_MANAGED
.public final IdentityProviderType identityProviderType()
Specifies the mode of authentication method enabled for this service. 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()
.
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.IdentityProviderType
public final String identityProviderTypeAsString()
Specifies the mode of authentication method enabled for this service. 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()
.
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.IdentityProviderType
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 events. When set, user activity can be viewed in your CloudWatch logs.
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.
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
public final boolean hasProtocols()
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.
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
public final String securityPolicyName()
Specifies the name of the security policy that is attached to the server.
public final String serverId()
Specifies the unique system-assigned identifier for a server that you instantiate.
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()
.
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.
State
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()
.
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.
State
public final boolean hasTags()
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.
public final Integer userCount()
Specifies the number of users that are assigned to a server you specified with the ServerId
.
ServerId
.public DescribedServer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
public static DescribedServer.Builder builder()
public static Class<? extends DescribedServer.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()