EndpointDetails - AWS Transfer Family

EndpointDetails

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.

Contents

AddressAllocationIds

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.

Note

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

Type: Array of strings

Required: No

SubnetIds

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

Note

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

Type: Array of strings

Required: No

VpcEndpointId

The ID of the VPC endpoint.

Note

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

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^vpce-[0-9a-f]{17}$

Required: No

VpcId

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

Note

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: