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

Inherits:

Struct

Object
Struct
Aws::Transfer::Types::DescribedServer

show all

Includes:: Structure

Defined in:: 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

#arn ⇒ String

Specifies the unique Amazon Resource Name (ARN) of the server.
#certificate ⇒ String

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
#domain ⇒ String

Specifies the domain of the storage system that is used for file transfers.
#endpoint_details ⇒ Types::EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your server.
#endpoint_type ⇒ String

Defines the type of endpoint that your server is connected to.
#host_key_fingerprint ⇒ String

Specifies the Base64-encoded SHA256 fingerprint of the server’s host key.
#identity_provider_details ⇒ Types::IdentityProviderDetails

Specifies information to call a customer-supplied authentication API.
#identity_provider_type ⇒ String

The mode of authentication for a server.
#logging_role ⇒ String

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
#post_authentication_login_banner ⇒ String

Specifies a string to display when users connect to a server.
#pre_authentication_login_banner ⇒ String

Specifies a string to display when users connect to a server.
#protocol_details ⇒ Types::ProtocolDetails

The protocol settings that are configured for your server.
#protocols ⇒ Array<String>

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server’s endpoint.
#security_policy_name ⇒ String

Specifies the name of the security policy that is attached to the server.
#server_id ⇒ String

Specifies the unique system-assigned identifier for a server that you instantiate.
#state ⇒ String

The condition of the server that was described.
#tags ⇒ Array<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.
#user_count ⇒ Integer

Specifies the number of users that are assigned to a server you specified with the ‘ServerId`.
#workflow_details ⇒ Types::WorkflowDetails

Specifies the workflow ID for the workflow to assign and the execution role that’s used for executing the workflow.

Instance Attribute Details

#arn ⇒ `String`

Specifies the unique Amazon Resource Name (ARN) of the server.

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#certificate ⇒ `String`

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when ‘Protocols` is set to `FTPS`.

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#domain ⇒ `String`

Specifies the domain of the storage system that is used for file transfers.

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#endpoint_details ⇒ `Types::EndpointDetails`

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC’s default security groups are automatically assigned to your endpoint.

Returns:

(Types::EndpointDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#endpoint_type ⇒ `String`

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)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#host_key_fingerprint ⇒ `String`

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)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

class DescribedServer < Struct.new(
  :arn,
  :certificate,
  :protocol_details,
  :domain,
  :endpoint_details,
  :endpoint_type,
  :host_key_fingerprint,
  :identity_provider_details,
  :identity_provider_type,
  :logging_role,
  :post_authentication_login_banner,
  :pre_authentication_login_banner,
  :protocols,
  :security_policy_name,
  :server_id,
  :state,
  :tags,
  :user_count,
  :workflow_details)
  SENSITIVE = []
  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 a server is `AWS_DIRECTORY_SERVICE` or `SERVICE_MANAGED`.

Returns:

(Types::IdentityProviderDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#identity_provider_type ⇒ `String`

The mode of authentication for a server. The default value is ‘SERVICE_MANAGED`, which allows you to store and access user credentials within the Transfer Family service.

Use ‘AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter.

Use the ‘API_GATEWAY` value to integrate with an identity provider of your choosing. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter.

Use the ‘AWS_LAMBDA` value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter or the `IdentityProviderDetails` data type.

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#logging_role ⇒ `String`

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#post_authentication_login_banner ⇒ `String`

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

<note markdown=“1”> The SFTP protocol does not support post-authentication display banners.

</note>

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#pre_authentication_login_banner ⇒ `String`

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

‘This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.`

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#protocol_details ⇒ `Types::ProtocolDetails`

The protocol settings that are configured for your server.

To indicate passive mode (for FTP and FTPS protocols), use the ‘PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the ‘SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the ‘TlsSessionResumptionMode` parameter.
‘As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

Returns:

(Types::ProtocolDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#protocols ⇒ `Array<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
‘AS2` (Applicability Statement 2): used for transporting structured business-to-business data

<note markdown=“1”> * If you select ‘FTPS`, you must choose a certificate stored in

Certificate Manager (ACM) which is used to identify your server
when clients connect to it over FTPS.

If ‘Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`.
If ‘Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated.
If ‘Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`.
If ‘Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, and domain must be Amazon S3.

</note>

Returns:

(Array<String>)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#security_policy_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#server_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#state ⇒ `String`

The condition of 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)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#tags ⇒ `Array<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:

(Array<Types::Tag>)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#user_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

#workflow_details ⇒ `Types::WorkflowDetails`

Specifies the workflow ID for the workflow to assign and the execution role that’s used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, ‘WorkflowDetails` can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

Returns:

(Types::WorkflowDetails)

# File 'lib/aws-sdk-transfer/types.rb', line 2411

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#certificate ⇒ String

#domain ⇒ String

#endpoint_details ⇒ Types::EndpointDetails

#endpoint_type ⇒ String

#host_key_fingerprint ⇒ String

#identity_provider_details ⇒ Types::IdentityProviderDetails

#identity_provider_type ⇒ String

#logging_role ⇒ String

#post_authentication_login_banner ⇒ String

#pre_authentication_login_banner ⇒ String

#protocol_details ⇒ Types::ProtocolDetails

#protocols ⇒ Array<String>

#security_policy_name ⇒ String

#server_id ⇒ String

#state ⇒ String

#tags ⇒ Array<Types::Tag>

#user_count ⇒ Integer

#workflow_details ⇒ Types::WorkflowDetails

#arn ⇒ `String`

#certificate ⇒ `String`

#domain ⇒ `String`

#endpoint_details ⇒ `Types::EndpointDetails`

#endpoint_type ⇒ `String`

#host_key_fingerprint ⇒ `String`

#identity_provider_details ⇒ `Types::IdentityProviderDetails`

#identity_provider_type ⇒ `String`

#logging_role ⇒ `String`

#post_authentication_login_banner ⇒ `String`

#pre_authentication_login_banner ⇒ `String`

#protocol_details ⇒ `Types::ProtocolDetails`

#protocols ⇒ `Array<String>`

#security_policy_name ⇒ `String`

#server_id ⇒ `String`

#state ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#user_count ⇒ `Integer`

#workflow_details ⇒ `Types::WorkflowDetails`