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

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

Overview

Returns properties of the server that was specified.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#endpoint_type ⇒ String

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.

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#identity_provider_type ⇒ String

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`.

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#logging_role ⇒ String

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

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#server_id ⇒ String

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

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#state ⇒ String

This property describes the condition of the SFTP server for the server that was described. A value of ‘ONLINE`&gt; 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) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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

#user_count ⇒ 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`.

Returns:

  • (Integer) 


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/aws-sdk-transfer/types.rb', line 1047

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