custom_routing_port_mappings

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

Overview

Name	custom_routing_port_mappings
Type	Resource
Id	aws.globalaccelerator.custom_routing_port_mappings

Fields

The following fields are returned by SELECT queries:

list_custom_routing_port_mappings

Name	Datatype	Description
accelerator_port	integer	The accelerator port.
destination_socket_address	object	The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.
destination_traffic_state	string	Indicates 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_arn	string	The Amazon Resource Name (ARN) of the endpoint group.
endpoint_id	string	The IP address of the VPC subnet (the subnet ID).
protocols	array	The protocols supported by the endpoint group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_custom_routing_port_mappings	select	region		Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator. The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_custom_routing_port_mappings

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator. The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.

SELECT
accelerator_port,
destination_socket_address,
destination_traffic_state,
endpoint_group_arn,
endpoint_id,
protocols
FROM aws.globalaccelerator.custom_routing_port_mappings
WHERE region = '{{ region }}' -- required
;