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 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 https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-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.
EndpointType
is set to VPC
and it is only valid in the UpdateServer
API.
2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2894 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.
2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2894 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
.
2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2894 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.
2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2894 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
.
2894 2895 2896 2897 2898 2899 2900 2901 2902 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2894 class EndpointDetails < Struct.new( :address_allocation_ids, :subnet_ids, :vpc_endpoint_id, :vpc_id, :security_group_ids) SENSITIVE = [] include Aws::Structure end |