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 your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your 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.
Note This property can only be set when
EndpointType
is set toVPC
and it is only valid in theUpdateServer
API.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
.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.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.