AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#domainString

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

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#endpoint_typeString

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)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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_typeString

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.

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#logging_roleString

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.

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#server_idString

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

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#stateString

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.

Returns:

  • (String)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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

#user_countInteger

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

Returns:

  • (Integer)


2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2841

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