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:

{
  endpoint_details: {
    vpc_endpoint_id: "VpcEndpointId",
  },
  endpoint_type: "PUBLIC", # accepts PUBLIC, 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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_detailsTypes::EndpointDetails

The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter.

Returns:

  • (Types::EndpointDetails)

    The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.

#endpoint_typeString

The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn\'t accessible over the public internet.

Possible values:

  • PUBLIC
  • VPC_ENDPOINT

Returns:

  • (String)

    The type of VPC endpoint that you want your SFTP 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 server to a new AWS SFTP server, don\'t update the host key. Accidentally changing a server\'s host key can be disruptive.

For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key%22 in the AWS SFTP 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

This parameter is required when the 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. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.

Returns:

#identity_provider_typeString

Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP 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 the SFTP server.

#logging_roleString

A value that allows the service to write your SFTP users\' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

Returns:

  • (String)

    A value that allows the service to write your SFTP users\' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

#tagsArray<Types::Tag>

Key-value pairs that can be used to group and search for servers.

Returns:

  • (Array<Types::Tag>)

    Key-value pairs that can be used to group and search for servers.