You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Transfer::Types::CreateServerRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateServerRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  certificate: "Certificate",
  endpoint_details: {
    address_allocation_ids: ["AddressAllocationId"],
    subnet_ids: ["SubnetId"],
    vpc_endpoint_id: "VpcEndpointId",
    vpc_id: "VpcId",
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, VPC, VPC_ENDPOINT
  host_key: "HostKey",
  identity_provider_details: {
    url: "Url",
    invocation_role: "Role",
  },
  identity_provider_type: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, API_GATEWAY
  logging_role: "Role",
  protocols: ["SFTP"], # accepts SFTP, FTP, FTPS
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificateString

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

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.

#endpoint_detailsTypes::EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC\'s default security groups are automatically assigned to your endpoint.

Returns:

  • (Types::EndpointDetails)

    The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server.

#endpoint_typeString

The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

Possible values:

  • PUBLIC
  • VPC
  • VPC_ENDPOINT

Returns:

  • (String)

    The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to.

#host_keyString

The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key command.

If you aren\'t planning to migrate existing users from an existing SFTP-enabled server to a new server, don\'t update the host key. Accidentally changing a server\'s host key can be disruptive.

For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.

Returns:

  • (String)

    The RSA private key as generated by the ssh-keygen -N "" -f my-new-server-key command.

#identity_provider_detailsTypes::IdentityProviderDetails

Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

Returns:

#identity_provider_typeString

Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Possible values:

  • SERVICE_MANAGED
  • API_GATEWAY

Returns:

  • (String)

    Specifies the mode of authentication for a file transfer protocol-enabled server.

#logging_roleString

Allows the service to write your users\' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Returns:

  • (String)

    Allows the service to write your users\' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

#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:

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

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

  • File Transfer Protocol (FTP): Unencrypted file transfer

Returns:

  • (Array<String>)

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

#tagsArray<Types::Tag>

Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.

Returns:

  • (Array<Types::Tag>)

    Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.