AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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",
  security_group_ids: ["SecurityGroupId"],
}

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 server\'s endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Returns:

  • (Array<String>)

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

#security_group_idsArray<String>

A list of security groups IDs that are available to attach to your server\'s endpoint.

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

You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC.

Returns:

  • (Array<String>)

    A list of security groups IDs that are available to attach to your server\'s endpoint.

#subnet_idsArray<String>

A list of subnet IDs that are required to host your server endpoint in your VPC.

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

Returns:

  • (Array<String>)

    A list of subnet IDs that are required to host your server endpoint in your VPC.

#vpc_endpoint_idString

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT.

Returns:

  • (String)

    The ID of the VPC endpoint.

#vpc_idString

The VPC ID of the VPC in which a server\'s endpoint will be hosted.

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

Returns:

  • (String)

    The VPC ID of the VPC in which a server\'s endpoint will be hosted.