GetServerResult

data class GetServerResult(val arn: String, val certificate: String, val domain: String, val endpoint: String, val endpointType: String, val id: String, val identityProviderType: String, val invocationRole: String, val loggingRole: String, val protocols: List<String>, val securityPolicyName: String, val serverId: String, val url: String)

A collection of values returned by getServer.

Constructors

Link copied to clipboard
constructor(arn: String, certificate: String, domain: String, endpoint: String, endpointType: String, id: String, identityProviderType: String, invocationRole: String, loggingRole: String, protocols: List<String>, securityPolicyName: String, serverId: String, url: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

ARN of Transfer Server.

Link copied to clipboard

ARN of any certificate.

Link copied to clipboard

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

Link copied to clipboard

Endpoint of the Transfer Server (e.g., s-12345678.server.transfer.REGION.amazonaws.com).

Link copied to clipboard

Type of endpoint that the server is connected to.

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the service. API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Link copied to clipboard

ARN of the IAM role used to authenticate the user account with an identity_provider_type of API_GATEWAY.

Link copied to clipboard

ARN of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Link copied to clipboard

File transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
val url: String

URL of the service endpoint used to authenticate users with an identity_provider_type of API_GATEWAY.