You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Transfer::Types::DescribedServerSpecifies the unique Amazon Resource Name (ARN) of the server.
Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
Defines the type of endpoint that your server is connected to.
Specifies the Base64-encoded SHA256 fingerprint of the server\'s host key.
Specifies information to call a customer-supplied authentication API.
Specifies the mode of authentication method enabled for this service.
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint.
Specifies the name of the security policy that is attached to the server.
Specifies the unique system-assigned identifier for a server that you instantiate.
Specifies the condition of a server for the server that was described.
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
Specifies the number of users that are assigned to a server you specified with the ServerId
.
Specifies the unique Amazon Resource Name (ARN) of the server.
#certificate ⇒ StringSpecifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
#endpoint_type ⇒ StringDefines 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.
Possible values:
Specifies the Base64-encoded SHA256 fingerprint of the server\'s host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key
command.
Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType
of a server is SERVICE_MANAGED
.
Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED
means that you are using this 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.
Possible values:
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.
#protocols ⇒ Array<String>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
Specifies the name of the security policy that is attached to the server.
#server_id ⇒ StringSpecifies the unique system-assigned identifier for a server that you instantiate.
#state ⇒ StringSpecifies 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:
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
#user_count ⇒ IntegerSpecifies the number of users that are assigned to a server you specified with the ServerId
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4