You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Transfer::Types::DescribedServer
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::DescribedServer
- Defined in:
- (unknown)
Overview
Describes the properties of a file transfer protocol-enabled server that was specified.
Returned by:
Instance Attribute Summary collapse
-
#arn ⇒ String
Specifies the unique Amazon Resource Name (ARN) of the server.
-
#certificate ⇒ String
Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
-
#endpoint_details ⇒ Types::EndpointDetails
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
-
#endpoint_type ⇒ String
Defines the type of endpoint that your server is connected to.
-
#host_key_fingerprint ⇒ String
Specifies the Base64-encoded SHA256 fingerprint of the server\'s host key.
-
#identity_provider_details ⇒ Types::IdentityProviderDetails
Specifies information to call a customer-supplied authentication API.
-
#identity_provider_type ⇒ String
Specifies the mode of authentication method enabled for this service.
-
#logging_role ⇒ String
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events.
-
#protocols ⇒ Array<String>
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint.
-
#security_policy_name ⇒ String
Specifies the name of the security policy that is attached to the server.
-
#server_id ⇒ String
Specifies the unique system-assigned identifier for a server that you instantiate.
-
#state ⇒ String
Specifies the condition of a server for the server that was described.
-
#tags ⇒ Array<Types::Tag>
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 ⇒ 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) of the server.
#certificate ⇒ String
Specifies the ARN of the AWS Certificate Manager (ACM) certificate.
Required when Protocols
is set to FTPS
.
#endpoint_details ⇒ Types::EndpointDetails
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
#endpoint_type ⇒ String
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.
Possible values:
- PUBLIC
- VPC
- VPC_ENDPOINT
#host_key_fingerprint ⇒ String
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.
#identity_provider_details ⇒ Types::IdentityProviderDetails
Specifies information to call a customer-supplied authentication API.
This field is not populated when the IdentityProviderType
of a server
is SERVICE_MANAGED
.
#identity_provider_type ⇒ String
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:
- 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 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 SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transfer
#security_policy_name ⇒ String
Specifies the name of the security policy that is attached to the server.
#server_id ⇒ String
Specifies the unique system-assigned identifier for a server that you instantiate.
#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
#tags ⇒ Array<Types::Tag>
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 ⇒ Integer
Specifies the number of users that are assigned to a server you
specified with the ServerId
.