You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Transfer::Types::ListedServer
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::ListedServer
- Defined in:
- (unknown)
Overview
Returns properties of a file transfer protocol-enabled server that was specified.
Instance Attribute Summary collapse
-
#arn ⇒ String
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
-
#endpoint_type ⇒ String
Specifies the type of VPC endpoint that your server is connected to.
-
#identity_provider_type ⇒ String
Specifies the authentication method used to validate a user for a server that was specified.
-
#logging_role ⇒ String
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
-
#server_id ⇒ String
Specifies the unique system assigned identifier for the servers that were listed.
-
#state ⇒ String
Specifies the condition of a server for the server that was described.
-
#user_count ⇒ Integer
Specifies the number of users that are assigned to a server you specified with the
ServerId
.
Instance Attribute Details
#arn ⇒ String
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
#endpoint_type ⇒ String
Specifies the type of VPC 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.
Possible values:
- PUBLIC
- VPC
- VPC_ENDPOINT
#identity_provider_type ⇒ String
Specifies the authentication method used to validate a user for a server
that was specified. This can include Secure Shell (SSH), user name and
password combinations, or your own custom authentication method. Valid
values include SERVICE_MANAGED
or API_GATEWAY
.
Possible values:
- SERVICE_MANAGED
- API_GATEWAY
#logging_role ⇒ String
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
#server_id ⇒ String
Specifies the unique system assigned identifier for the servers that were listed.
#state ⇒ String
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.
Possible values:
- OFFLINE
- ONLINE
- STARTING
- STOPPING
- START_FAILED
- STOP_FAILED
#user_count ⇒ Integer
Specifies the number of users that are assigned to a server you
specified with the ServerId
.