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

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

Overview

Describes the 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) of the server.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#certificateString

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_detailsTypes::EndpointDetails

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_typeString

Defines the type of 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)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#host_key_fingerprintString

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_detailsTypes::IdentityProviderDetails

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



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#identity_provider_typeString

Specifies 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 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)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :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 for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#protocolsArray<String>

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

Returns:

  • (Array<String>)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#security_policy_nameString

Specifies the name of the security policy that is attached to the server.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#server_idString

Specifies the unique system-assigned identifier for a server that you instantiate.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :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)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :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)


752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 752

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count)
  SENSITIVE = []
  include Aws::Structure
end