Class: Aws::Transfer::Types::DescribedServer
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::DescribedServer
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-transfer/types.rb
Overview
Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.
Instance Attribute Summary collapse
-
#arn ⇒ String
Specifies the unique Amazon Resource Name (ARN) for the server to be described.
-
#endpoint_details ⇒ Types::EndpointDetails
The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
-
#endpoint_type ⇒ String
The type of endpoint that your SFTP server is connected to.
-
#host_key_fingerprint ⇒ String
This value contains the message-digest algorithm (MD5) hash of the server’s host key.
-
#identity_provider_details ⇒ Types::IdentityProviderDetails
Specifies information to call a customer-supplied authentication API.
-
#identity_provider_type ⇒ String
This property defines the mode of authentication method enabled for this service.
-
#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.
-
#server_id ⇒ String
This property is a unique system-assigned identifier for the SFTP server that you instantiate.
-
#state ⇒ String
The condition of the SFTP server for the server that was described.
-
#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.
-
#user_count ⇒ Integer
The number of users that are assigned to the SFTP server you specified with the ‘ServerId`.
Instance Attribute Details
#arn ⇒ String
Specifies the unique Amazon Resource Name (ARN) for the server to be described.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :identity_provider_details, :identity_provider_type, :logging_role, :server_id, :state, :tags, :user_count) include Aws::Structure end |
#endpoint_details ⇒ Types::EndpointDetails
The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :identity_provider_details, :identity_provider_type, :logging_role, :server_id, :state, :tags, :user_count) include Aws::Structure end |
#endpoint_type ⇒ String
The type of 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.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :identity_provider_details, :identity_provider_type, :logging_role, :server_id, :state, :tags, :user_count) include Aws::Structure end |
#host_key_fingerprint ⇒ String
This value contains the message-digest algorithm (MD5) hash of the server’s host key. This value is equivalent to the output of the ‘ssh-keygen -l -E md5 -f my-new-server-key` command.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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`>.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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 viewed in your CloudWatch logs.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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` 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.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :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`.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/aws-sdk-transfer/types.rb', line 521 class DescribedServer < Struct.new( :arn, :endpoint_details, :endpoint_type, :host_key_fingerprint, :identity_provider_details, :identity_provider_type, :logging_role, :server_id, :state, :tags, :user_count) include Aws::Structure end |