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

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::EndpointDetails

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-transfer/types.rb', line 2682

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>)

# File 'lib/aws-sdk-transfer/types.rb', line 2682

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>)

# File 'lib/aws-sdk-transfer/types.rb', line 2682

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)

# File 'lib/aws-sdk-transfer/types.rb', line 2682

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)

# File 'lib/aws-sdk-transfer/types.rb', line 2682

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