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 address to your server's
endpoint.
Note
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your AWSaccount if your account hasn't already
done so before May 19, 2021. If you have already created servers with
EndpointType=VPC_ENDPOINT
in your AWSaccount on or before May 19, 2021,
you will not be affected. After this date, use
EndpointType
=VPC
.
For more information, see Discontinuing the use of VPC_ENDPOINT.
Contents
- AddressAllocationIds
-
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
Note
This property can only be set when
EndpointType
is set toVPC
and it is only valid in theUpdateServer
API.Type: Array of strings
Required: No
- SecurityGroupIds
-
A list of security groups IDs that are available to attach to your server's endpoint.
Note
This property can only be set when
EndpointType
is set toVPC
.You can edit the
SecurityGroupIds
property in the UpdateServer API only if you are changing theEndpointType
fromPUBLIC
orVPC_ENDPOINT
toVPC
. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.Type: Array of strings
Length Constraints: Minimum length of 11. Maximum length of 20.
Pattern:
sg-[0-9a-f]{8,17}
Required: No
- SubnetIds
-
A list of subnet IDs that are required to host your server endpoint in your VPC.
Note
This property can only be set when
EndpointType
is set toVPC
.Type: Array of strings
Required: No
- VpcEndpointId
-
The identifier of the VPC endpoint.
Note
This property can only be set when
EndpointType
is set toVPC_ENDPOINT
.For more information, see Discontinuing the use of VPC_ENDPOINT.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
vpce-[0-9a-f]{17}
Required: No
- VpcId
-
The VPC identifier of the VPC in which a server's endpoint will be hosted.
Note
This property can only be set when
EndpointType
is set toVPC
.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: