class Aws::Transfer::Types::ListedServer

Returns properties of a file transfer protocol-enabled server that was specified.

@!attribute [rw] arn

Specifies the unique Amazon Resource Name (ARN) for a server to be
listed.
@return [String]

@!attribute [rw] domain

Specifies the domain of the storage system that is used for file
transfers.
@return [String]

@!attribute [rw] identity_provider_type

Specifies the mode of authentication for a server. The default value
is `SERVICE_MANAGED`, which allows you to store and access user
credentials within the Amazon Web Services Transfer Family service.

Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory
groups in Amazon Web Services Managed Active Directory or Microsoft
Active Directory in your on-premises environment or in Amazon Web
Services using AD Connectors. This option also requires you to
provide a Directory ID using the `IdentityProviderDetails`
parameter.

Use the `API_GATEWAY` value to integrate with an identity provider
of your choosing. The `API_GATEWAY` setting requires you to provide
an API Gateway endpoint URL to call for authentication using the
`IdentityProviderDetails` parameter.
@return [String]

@!attribute [rw] endpoint_type

Specifies the type of VPC 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.
@return [String]

@!attribute [rw] logging_role

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services
Identity and Access Management (IAM) role that allows a server to
turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS
events. When set, user activity can be viewed in your CloudWatch
logs.
@return [String]

@!attribute [rw] server_id

Specifies the unique system assigned identifier for the servers that
were listed.
@return [String]

@!attribute [rw] state

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.
@return [String]

@!attribute [rw] user_count

Specifies the number of users that are assigned to a server you
specified with the `ServerId`.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedServer AWS API Documentation

Constants

SENSITIVE