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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

class ListedServer < Struct.new(
  :arn,
  :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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

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

#identity_provider_typeString

Specifies the authentication method used to validate a user for a 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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

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

#logging_roleString

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.

Returns:

  • (String)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

class ListedServer < Struct.new(
  :arn,
  :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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

class ListedServer < Struct.new(
  :arn,
  :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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

class ListedServer < Struct.new(
  :arn,
  :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)


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1366

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