Class: Aws::Transfer::Types::EndpointDetails

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

<note markdown=“1”> After May 19, 2021, you won’t be able to create a server using ‘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

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`.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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][2

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].

<note markdown=“1”> This property can only be set as follows:

* `EndpointType` must be set to `VPC`

  • 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` and `AddressAllocationIds` cannot be updated simultaneously).

  • ‘AddressAllocationIds` can’t contain duplicates, and must be equal in length to ‘SubnetIds`. 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.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html [3]: docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint

Returns:

  • (Array<String>) 


3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-transfer/types.rb', line 3433

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.

<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] API.

</note>

[1]: docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html [2]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html

Returns:

  • (Array<String>) 


3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-transfer/types.rb', line 3433

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.

<note markdown=“1”> This property can only be set when ‘EndpointType` is set to `VPC`.

</note>

Returns:

  • (Array<String>) 


3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-transfer/types.rb', line 3433

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.

<note markdown=“1”> This property can only be set when ‘EndpointType` is set to `VPC_ENDPOINT`.

For more information, see

docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

</note>

Returns:

  • (String) 


3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-transfer/types.rb', line 3433

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.

<note markdown=“1”> This property can only be set when ‘EndpointType` is set to `VPC`.

</note>

Returns:

  • (String) 


3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-transfer/types.rb', line 3433

class EndpointDetails < Struct.new(
  :address_allocation_ids,
  :subnet_ids,
  :vpc_endpoint_id,
  :vpc_id,
  :security_group_ids)
  SENSITIVE = []
  include Aws::Structure
end