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
show all
Defined in:
(unknown)

Overview

Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the certificate ARN (if the FTPS protocol was selected), the endpoint type and details, the authentication configuration and type, the logging role, the file transfer protocol or protocols, the server ID and state, and assigned tags or metadata.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

Returns:

  • (String)

    Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

#certificateString

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

Returns:

  • (String)

    Specifies the ARN of the AWS Certificate Manager (ACM) certificate.

#endpoint_detailsTypes::EndpointDetails

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

Returns:

  • (Types::EndpointDetails)

    Specifies the virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

#endpoint_typeString

Defines the type of endpoint that your file transfer protocol-enabled 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

Returns:

  • (String)

    Defines the type of endpoint that your file transfer protocol-enabled server is connected to.

#host_key_fingerprintString

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:

  • (String)

    Specifies the Base64-encoded SHA256 fingerprint of the server\'s host key.

#identity_provider_detailsTypes::IdentityProviderDetails

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

Returns:

#identity_provider_typeString

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled 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

Returns:

  • (String)

    Specifies the mode of authentication method enabled for this service.

#logging_roleString

Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

  • (String)

    Specifies the AWS Identity and Access Management (IAM) role that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events.

#protocolsArray<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

Returns:

  • (Array<String>)

    Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server\'s endpoint.

#server_idString

Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

Returns:

  • (String)

    Specifies the unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

#stateString

Specifies the condition of a file transfer protocol-enabled 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

Returns:

  • (String)

    Specifies the condition of a file transfer protocol-enabled server for the server that was described.

#tagsArray<Types::Tag>

Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

Returns:

  • (Array<Types::Tag>)

    Specifies the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

#user_countInteger

Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

Returns:

  • (Integer)

    Specifies the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.