AWS::Transfer::Server EndpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. You VPC's default security groups are automatically assigned to your endpoint.
It is recommended that you use VPC
as the EndpointType
.
With this endpoint type, you have the option to directly associate up to three Elastic
IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security
groups
to restrict traffic by the client's public IP address. This is not possible with
EndpointType
set to VPC_ENDPOINT
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AddressAllocationIds" :
[ String, ... ]
, "SecurityGroupIds" :[ String, ... ]
, "SubnetIds" :[ String, ... ]
, "VpcEndpointId" :String
, "VpcId" :String
}
YAML
AddressAllocationIds:
- String
SecurityGroupIds:- String
SubnetIds:- String
VpcEndpointId:String
VpcId:String
Properties
AddressAllocationIds
-
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint. This is only valid in the
UpdateServer
API.Note This property can only be set when
EndpointType
is set toVPC
.Required: No
Type: List of String
Update requires: Some interruptions
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
.Maximum number of security groups: 5
Required: No
Type: List of String
Update requires: No interruption
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
.Required: No
Type: List of String
Update requires: No interruption
VpcEndpointId
-
The ID of the VPC endpoint.
Note This property can only be set when
EndpointType
is set toVPC_ENDPOINT
.Required: No
Type: String
Minimum:
22
Maximum:
22
Pattern:
^vpce-[0-9a-f]{17}$
Update requires: No interruption
VpcId
-
The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.
Note This property can only be set when
EndpointType
is set toVPC
.Required: No
Type: String
Update requires: No interruption
See also
EndpointDetails in the AWS Transfer Family User Guide.