Class: Aws::Transfer::Types::EndpointDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::EndpointDetails
- Defined in:
- gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb
Overview
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.
EndpointType=VPC_ENDPOINT
in your Amazon Web Services account 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 Services account on or before May 19, 2021, you will not be
affected. After this date, use EndpointType
=VPC
.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-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
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#address_allocation_ids ⇒ Array<String>
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
-
#security_group_ids ⇒ Array<String>
A list of security groups IDs that are available to attach to your server's endpoint.
-
#subnet_ids ⇒ Array<String>
A list of subnet IDs that are required to host your server endpoint in your VPC.
-
#vpc_endpoint_id ⇒ String
The identifier of the VPC endpoint.
-
#vpc_id ⇒ String
The VPC identifier of the VPC in which a server's endpoint will be hosted.
Instance Attribute Details
#address_allocation_ids ⇒ Array<String>
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
An address allocation ID corresponds to the allocation ID of an
Elastic IP address. This value can be retrieved from the
allocationId
field from the Amazon EC2 Address data type. One
way to retrieve this value is by calling the EC2
DescribeAddresses API.
This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server.
EndpointType
must be set toVPC
The Transfer Family server must be offline.
You cannot set this parameter for Transfer Family servers that use the FTP protocol.
The server must already have
SubnetIds
populated (SubnetIds
andAddressAllocationIds
cannot be updated simultaneously).AddressAllocationIds
can't contain duplicates, and must be equal in length toSubnetIds
. For example, if you have three subnet IDs, you must also specify three address allocation IDs.Call the
UpdateServer
API to set or change this parameter.
3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3108 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |
#security_group_ids ⇒ Array<String>
A list of security groups IDs that are available to attach to your server's endpoint.
EndpointType
is set to VPC
.
You can edit the SecurityGroupIds
property in the
UpdateServer 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 API.
3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3108 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |
#subnet_ids ⇒ Array<String>
A list of subnet IDs that are required to host your server endpoint in your VPC.
EndpointType
is set to VPC
.
3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3108 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |
#vpc_endpoint_id ⇒ String
The identifier of the VPC endpoint.
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.
3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3108 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |
#vpc_id ⇒ String
The VPC identifier of the VPC in which a server's endpoint will be hosted.
EndpointType
is set to VPC
.
3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3108 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |