ipam_discovered_public_addresses

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

Overview

Name	ipam_discovered_public_addresses
Type	Resource
Id	aws.ec2.ipam_discovered_public_addresses

Fields

The following fields are returned by SELECT queries:

get_ipam_discovered_public_addresses

Name	Datatype	Description
address	string	The IP address.
address_allocation_id	string	The allocation ID of the resource the IP address is assigned to.
address_owner_id	string	The ID of the owner of the resource the IP address is assigned to.
address_region	string	The Region of the resource the IP address is assigned to.
address_type	string	The IP address type.
association_status	string	The association status.
instance_id	string	The instance ID of the instance the assigned IP address is assigned to.
ipam_resource_discovery_id	string	The resource discovery ID.
network_border_group	string	The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.
network_interface_description	string	The description of the network interface that IP address is assigned to.
network_interface_id	string	The network interface ID of the resource with the assigned IP address.
public_ipv_4_pool_id	string	The ID of the public IPv4 pool that the resource with the assigned IP address is from.
sample_time	string	The last successful resource discovery time.
security_groups	string	Security groups associated with the resource that the IP address is assigned to.
service	string	The Amazon Web Services service associated with the IP address.
service_resource	string	The resource ARN or ID.
subnet_id	string	The ID of the subnet that the resource with the assigned IP address is in.
tags	string	Tags associated with the IP address.
vpc_id	string	The ID of the VPC that the resource with the assigned IP address is in.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_discovered_public_addresses	select	IpamResourceDiscoveryId, AddressRegion, region	DryRun, Filter, NextToken, MaxResults	Gets the public IP addresses that have been discovered by IPAM.

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
AddressRegion	string	The Amazon Web Services Region for the IP address.
IpamResourceDiscoveryId	string	An IPAM resource discovery ID.
region	string	AWS region (default: us-east-1)
DryRun	boolean	A check for whether you have the required permissions for the action 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	Filters.
MaxResults	integer	The maximum number of IPAM discovered public addresses to return in one page of results.
NextToken	string	The token for the next page of results.

SELECT examples

get_ipam_discovered_public_addresses

Gets the public IP addresses that have been discovered by IPAM.

SELECT
address,
address_allocation_id,
address_owner_id,
address_region,
address_type,
association_status,
instance_id,
ipam_resource_discovery_id,
network_border_group,
network_interface_description,
network_interface_id,
public_ipv_4_pool_id,
sample_time,
security_groups,
service,
service_resource,
subnet_id,
tags,
vpc_id
FROM aws.ec2.ipam_discovered_public_addresses
WHERE IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' -- required
AND AddressRegion = '{{ AddressRegion }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;