Class: Aws::Transfer::Types::DescribedServer

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

Overview

Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#identity_provider_details ⇒ Types::IdentityProviderDetails

Specifies information to call a customer-supplied authentication API. This field is not populated when the ‘IdentityProviderType` of the server is `SERVICE_MANAGED`&gt;.

Returns:



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#identity_provider_type ⇒ String

This property defines the mode of authentication method enabled for this service. A value of ‘SERVICE_MANAGED`, means that you are using this Server to store and access SFTP user credentials within the service. A value of `API_GATEWAY` indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

  • (String) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#logging_role ⇒ String

This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

Returns:

  • (String) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#server_id ⇒ String

This property is a unique system assigned identifier for the SFTP server that you instantiate.

Returns:

  • (String) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#state ⇒ String

The condition of the SFTP 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` indicated 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) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

Returns:



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end

#user_count ⇒ Integer

The number of users that are assigned to the SFTP server you specified with the ‘ServerId`.

Returns:

  • (Integer) 


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/aws-sdk-transfer/types.rb', line 379

class DescribedServer < Struct.new(
  :arn,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :server_id,
  :state,
  :tags,
  :user_count)
  include Aws::Structure
end