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

Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, 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 the server to be described.

Returns:

  • (String)

    Specifies the unique Amazon Resource Name (ARN) for the server to be described.

#endpoint_detailsTypes::EndpointDetails

The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

Returns:

  • (Types::EndpointDetails)

    The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

#endpoint_typeString

The type of 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 endpoint that your SFTP server is connected to.

#host_key_fingerprintString

This value contains the Message-Digest Algorithm (MD5) hash of the server\'s host key. This value is equivalent to the output of ssh-keygen -l -E md5 -f my-new-server-key command.

Returns:

  • (String)

    This value contains the Message-Digest Algorithm (MD5) hash 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 the server is SERVICE_MANAGED>.

Returns:

#identity_provider_typeString

This property defines 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 SFTP 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)

    This property defines the mode of authentication method enabled for this service.

#logging_roleString

This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

Returns:

  • (String)

    This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events.

#server_idString

This property is a unique system assigned identifier for the SFTP server that you instantiate.

Returns:

  • (String)

    This property is a unique system assigned identifier for the SFTP server that you instantiate.

#stateString

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 indicated 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)

    The condition of the SFTP server for the server that was described.

#tagsArray<Types::Tag>

This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

Returns:

  • (Array<Types::Tag>)

    This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

#user_countInteger

The number of users that are assigned to the SFTP server you specified with the ServerId.

Returns:

  • (Integer)

    The number of users that are assigned to the SFTP server you specified with the ServerId.