Skip to main content

custom_routing_port_mappings_by_destinations

Creates, updates, deletes, gets or lists a custom_routing_port_mappings_by_destinations resource.

Overview

Namecustom_routing_port_mappings_by_destinations
TypeResource
Idaws.globalaccelerator.custom_routing_port_mappings_by_destinations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
accelerator_arnstringThe Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.
accelerator_socket_addressesarrayThe IP address/port combinations (sockets) that map to a given destination socket address.
destination_socket_addressobjectAn IP address/port combination.
destination_traffic_statestringIndicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination. (ALLOW, DENY)
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group.
endpoint_group_regionstringThe Amazon Web Services Region for the endpoint group.
endpoint_idstringThe ID for the virtual private cloud (VPC) subnet.
ip_address_typestringThe IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4. (IPV4, DUAL_STACK)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_custom_routing_port_mappings_by_destinationselectregionList the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.

SELECT
accelerator_arn,
accelerator_socket_addresses,
destination_socket_address,
destination_traffic_state,
endpoint_group_arn,
endpoint_group_region,
endpoint_id,
ip_address_type
FROM aws.globalaccelerator.custom_routing_port_mappings_by_destinations
WHERE region = '{{ region }}' -- required
;