ipam_discovered_resource_cidrs

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

Overview

Name	ipam_discovered_resource_cidrs
Type	Resource
Id	aws.ec2.ipam_discovered_resource_cidrs

Fields

The following fields are returned by SELECT queries:

get_ipam_discovered_resource_cidrs

Name	Datatype	Description
availability_zone_id	string	The Availability Zone ID.
ip_source	string	The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.
ip_usage	number	The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following: For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs).
ipam_resource_discovery_id	string	The resource discovery ID.
network_interface_attachment_status	string	For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.
resource_cidr	string	The resource CIDR.
resource_id	string	The resource ID.
resource_owner_id	string	The resource owner ID.
resource_region	string	The resource Region.
resource_tags	string	The resource tags.
resource_type	string	The resource type.
sample_time	string	The last successful resource discovery time.
subnet_id	string	The subnet ID.
vpc_id	string	The VPC ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_discovered_resource_cidrs	select	IpamResourceDiscoveryId, ResourceRegion, region	DryRun, Filter, NextToken, MaxResults	Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

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	A resource discovery ID.
ResourceRegion	string	A resource Region.
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 discovered resource CIDRs to return in one page of results.
NextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_ipam_discovered_resource_cidrs

Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.

SELECT
availability_zone_id,
ip_source,
ip_usage,
ipam_resource_discovery_id,
network_interface_attachment_status,
resource_cidr,
resource_id,
resource_owner_id,
resource_region,
resource_tags,
resource_type,
sample_time,
subnet_id,
vpc_id
FROM aws.ec2.ipam_discovered_resource_cidrs
WHERE IpamResourceDiscoveryId = '{{ IpamResourceDiscoveryId }}' -- required
AND ResourceRegion = '{{ ResourceRegion }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;