ipam_address_histories

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

Overview

Name	ipam_address_histories
Type	Resource
Id	aws.ec2.ipam_address_histories

Fields

The following fields are returned by SELECT queries:

get_ipam_address_history

Name	Datatype	Description
resource_cidr	string	The CIDR of the resource.
resource_compliance_status	string	The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
resource_id	string	The ID of the resource.
resource_name	string	The name of the resource.
resource_overlap_status	string	The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
resource_owner_id	string	The ID of the resource owner.
resource_region	string	The Amazon Web Services Region of the resource.
resource_type	string	The type of the resource.
sampled_end_time	string	Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.
sampled_start_time	string	Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
vpc_id	string	The VPC ID of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ipam_address_history	select	IpamScopeId, region	DryRun, Cidr, VpcId, StartTime, EndTime, MaxResults, NextToken	Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

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
IpamScopeId	string	The ID of the IPAM scope that the CIDR is in.
region	string	AWS region (default: us-east-1)
Cidr	string	The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
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.
EndTime	string (date-time)	The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
MaxResults	integer	The maximum number of historical results you would like returned per page. Defaults to 100.
NextToken	string	The token for the next page of results.
StartTime	string (date-time)	The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
VpcId	string	The ID of the VPC you want your history records filtered by.

SELECT examples

get_ipam_address_history

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

SELECT
resource_cidr,
resource_compliance_status,
resource_id,
resource_name,
resource_overlap_status,
resource_owner_id,
resource_region,
resource_type,
sampled_end_time,
sampled_start_time,
vpc_id
FROM aws.ec2.ipam_address_histories
WHERE IpamScopeId = '{{ IpamScopeId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Cidr = '{{ Cidr }}'
AND VpcId = '{{ VpcId }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;