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

Builder

Properties

The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

domain

var domain: Domain?

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?

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

hostKey

var hostKey: String?

The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.

identityProviderDetails

var identityProviderDetails: IdentityProviderDetails?

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when IdentityProviderType is set to 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.

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.

structuredLogDestinations

var structuredLogDestinations: List<String>?

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