transfer/aws.sdk.kotlin.services.transfer.model/DescribedServer/Builder

Builder

Properties

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

var as2ServiceManagedEgressIpAddresses: List<String>?

The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

certificate

var certificate: String?

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

domain

var domain: Domain?

Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

endpointDetails

var endpointDetails: 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.

endpointType

var endpointType: EndpointType?

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.

hostKeyFingerprint

var hostKeyFingerprint: 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.

identityProviderDetails

var identityProviderDetails: 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.

identityProviderType

var identityProviderType: IdentityProviderType?

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.

ipAddressType

var ipAddressType: IpAddressType?

Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

loggingRole

var loggingRole: 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 EFS events. When set, you can view user activity in your CloudWatch logs.

postAuthenticationLoginBanner

var postAuthenticationLoginBanner: String?

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

preAuthenticationLoginBanner

var preAuthenticationLoginBanner: 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:

protocolDetails

var protocolDetails: ProtocolDetails?

The protocol settings that are configured for your server.

protocols

var protocols: List<Protocol>?

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:

s3StorageOptions

var s3StorageOptions: S3StorageOptions?

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

securityPolicyName

var securityPolicyName: String?

Specifies the name of the security policy for the server.

serverId

var serverId: String?

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

state

var state: State?

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.

structuredLogDestinations

var structuredLogDestinations: List<String>?

Specifies the log groups to which your server logs are sent.