Class: Aws::Transfer::Types::ListedServer

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::ListedServer

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #domain ⇒ String

  Specifies the domain of the storage system that is used for file transfers.

• #endpoint_type ⇒ String

  Specifies the type of VPC endpoint that your server is connected to.

• #identity_provider_type ⇒ String

  The mode of authentication for a server.

• #logging_role ⇒ String

  The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.

• #server_id ⇒ String

  Specifies the unique system assigned identifier for the servers that were listed.

• #state ⇒ String

  The condition of 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) for a server to be listed.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

Specifies the domain of the storage system that is used for file transfers.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_type ⇒ String

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

Use `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by 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 Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter.

Use the `AWS_LAMBDA` value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter or the `IdentityProviderDetails` data type.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#logging_role ⇒ String

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#server_id ⇒ String

Specifies the unique system assigned identifier for the servers that were listed.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The condition of 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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#user_count ⇒ Integer

Specifies the number of users that are assigned to a server you specified with the `ServerId`.

Returns:

• (Integer)

# File 'lib/aws-sdk-transfer/types.rb', line 4082

class ListedServer < Struct.new(
  :arn,
  :domain,
  :identity_provider_type,
  :endpoint_type,
  :logging_role,
  :server_id,
  :state,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end