ipam_discovered_routes

Creates, updates, deletes, gets or lists an ipam_discovered_routes resource.

Overview

Name	ipam_discovered_routes
Type	Resource
Id	aws.ec2.ipam_discovered_routes

Fields

The following fields are returned by SELECT queries:

get_ipam_discovered_routes

Name	Datatype	Description
advertisement_type	string	The advertisement type of the route. Possible values: regional - The IP address is advertised from a single location (regional services such as Amazon EC2). global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).
asn	string	The Autonomous System Number (ASN) that originates the route.
cidr	string	The IP address prefix of the discovered route in CIDR notation.
ipam_pool_id	string	The ID of the IPAM pool associated with the route.
ipam_resource_discovery_id	string	The ID of the IPAM resource discovery that discovered the route.
network_border_group	string	The network border group for the route.
pool_id	string	The ID of the BYOIP pool associated with the route.
resource_owner_id	string	The ID of the resource owner.
resource_region	string	The Amazon Web Services Region where the route was discovered.
sample_time	string	The time when the route was last sampled.
state	string	The state of the BYOIP CIDR. Possible values: advertised - The CIDR is being advertised. deprovisioned - The CIDR has been deprovisioned. failed-deprovision - Deprovisioning failed. failed-provision - Provisioning failed. pending-deprovision - Deprovisioning is in progress. pending-provision - Provisioning is in progress. provisioned - The CIDR is provisioned. provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_discovered_routes	select	IpamResourceDiscoveryId, ResourceRegion, region	DryRun, Filter, NextToken, MaxResults	Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.

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
IpamResourceDiscoveryId	string	The ID of the IPAM resource discovery.
ResourceRegion	string	The Amazon Web Services Region to retrieve discovered routes for.
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters to apply to the results.
MaxResults	integer	The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.

SELECT examples

get_ipam_discovered_routes

Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
advertisement_type,
asn,
cidr,
ipam_pool_id,
ipam_resource_discovery_id,
network_border_group,
pool_id,
resource_owner_id,
resource_region,
sample_time,
state
FROM aws.ec2.ipam_discovered_routes
WHERE IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' -- required
AND ResourceRegion = '{{ ResourceRegion }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;