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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

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"],
}

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.

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 https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_allocation_idsArray<String>

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

Returns:

  • (Array<String>)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1944

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

#security_group_idsArray<String>

A list of security groups IDs that are available to attach to your server's endpoint.

This property can only be set when 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.

Returns:

  • (Array<String>)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1944

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

#subnet_idsArray<String>

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC.

Returns:

  • (Array<String>)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1944

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

#vpc_endpoint_idString

The ID of the VPC endpoint.

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.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1944

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

#vpc_idString

The VPC ID of the VPC in which a server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1944

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