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

Class: Aws::Transfer::Types::EndpointDetails

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

Overview

Note:

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

{
  address_allocation_ids: ["AddressAllocationId"],
  subnet_ids: ["SubnetId"],
  vpc_endpoint_id: "VpcEndpointId",
  vpc_id: "VpcId",
}

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#address_allocation_idsArray<String>

A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server\'s endpoint. This is only valid in the UpdateServer API.

This property can only be use when EndpointType is set to VPC.

Returns:

  • (Array<String>)

    A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server\'s endpoint.

#subnet_idsArray<String>

A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

Returns:

  • (Array<String>)

    A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

#vpc_endpoint_idString

The ID of the VPC endpoint.

Returns:

  • (String)

    The ID of the VPC endpoint.

#vpc_idString

The VPC ID of the VPC in which a file transfer protocol-enabled server\'s endpoint will be hosted.

Returns:

  • (String)

    The VPC ID of the VPC in which a file transfer protocol-enabled server\'s endpoint will be hosted.