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

Overview

Returns properties of the server that was specified.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The unique Amazon Resource Name (ARN) for the server to be listed.

Returns:

  • (String)

    The unique Amazon Resource Name (ARN) for the server to be listed.

#endpoint_typeString

The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn\'t accessible over the public internet.

Possible values:

  • PUBLIC
  • VPC_ENDPOINT

Returns:

  • (String)

    The type of VPC endpoint that your SFTP server is connected to.

#identity_provider_typeString

The authentication method used to validate a user for the 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

Returns:

  • (String)

    The authentication method used to validate a user for the server that was specified.

#logging_roleString

The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

Returns:

  • (String)

    The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

#server_idString

This value is the unique system assigned identifier for the SFTP servers that were listed.

Returns:

  • (String)

    This value is the unique system assigned identifier for the SFTP servers that were listed.

#stateString

This property describes the condition of the SFTP 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)

    This property describes the condition of the SFTP server for the server that was described.

#user_countInteger

This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.

Returns:

  • (Integer)

    This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.