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

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

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. To control incoming internet traffic, invoke the ‘UpdateServer` API and attach an Elastic IP to your server’s endpoint.

See Also:

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 SFTP server’s endpoint. This is only valid in the ‘UpdateServer` API.

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

</note>

Returns:

  • (Array<String>) 


668
669
670
671
672
673
674
 
# File 'lib/aws-sdk-transfer/types.rb', line 668

class EndpointDetails < Struct.new(
  :address_allocation_ids,
  :subnet_ids,
  :vpc_endpoint_id,
  :vpc_id)
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


668
669
670
671
672
673
674
 
# File 'lib/aws-sdk-transfer/types.rb', line 668

class EndpointDetails < Struct.new(
  :address_allocation_ids,
  :subnet_ids,
  :vpc_endpoint_id,
  :vpc_id)
  include Aws::Structure
end

#vpc_endpoint_id ⇒ String

The ID of the VPC endpoint.

Returns:

  • (String) 


668
669
670
671
672
673
674
 
# File 'lib/aws-sdk-transfer/types.rb', line 668

class EndpointDetails < Struct.new(
  :address_allocation_ids,
  :subnet_ids,
  :vpc_endpoint_id,
  :vpc_id)
  include Aws::Structure
end

#vpc_id ⇒ String

The VPC ID of the virtual private cloud in which the SFTP server’s endpoint will be hosted.

Returns:

  • (String) 


668
669
670
671
672
673
674
 
# File 'lib/aws-sdk-transfer/types.rb', line 668

class EndpointDetails < Struct.new(
  :address_allocation_ids,
  :subnet_ids,
  :vpc_endpoint_id,
  :vpc_id)
  include Aws::Structure
end