class Aws::Transfer::Types::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 markdown=“1”> After May 19, 2021, you won't be able to create a server using `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with `EndpointType=VPC_ENDPOINT` in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use `EndpointType`=`VPC`.
For more information, see
docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
</note>
@note When making an API call, you may pass EndpointDetails
data as a hash: { address_allocation_ids: ["AddressAllocationId"], subnet_ids: ["SubnetId"], vpc_endpoint_id: "VpcEndpointId", vpc_id: "VpcId", security_group_ids: ["SecurityGroupId"], }
@!attribute [rw] address_allocation_ids
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint. <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC` and it is only valid in the `UpdateServer` API. </note> @return [Array<String>]
@!attribute [rw] subnet_ids
A list of subnet IDs that are required to host your server endpoint in your VPC. <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`. </note> @return [Array<String>]
@!attribute [rw] vpc_endpoint_id
The ID of the VPC endpoint. <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC_ENDPOINT`. For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. </note> @return [String]
@!attribute [rw] vpc_id
The VPC ID of the VPC in which a server's endpoint will be hosted. <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`. </note> @return [String]
@!attribute [rw] security_group_ids
A list of security groups IDs that are available to attach to your server's endpoint. <note markdown="1"> This property can only be set when `EndpointType` is set to `VPC`. You can edit the `SecurityGroupIds` property in the [UpdateServer][1] API only if you are changing the `EndpointType` from `PUBLIC` or `VPC_ENDPOINT` to `VPC`. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 [ModifyVpcEndpoint][2] API. </note> [1]: https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/EndpointDetails AWS API Documentation
Constants
- SENSITIVE