Skip to main content

ipams_list_only

Lists ipams in a region or regions, for all properties use ipams

Overview

Nameipams_list_only
TypeResource
DescriptionResource Schema of AWS::EC2::IPAM Type
Idaws.ec2.ipams_list_only

Fields

NameDatatypeDescription
ipam_idstringId of the IPAM.
arnstringThe Amazon Resource Name (ARN) of the IPAM.
default_resource_discovery_idstringThe Id of the default resource discovery, created with this IPAM.
default_resource_discovery_association_idstringThe Id of the default association to the default resource discovery, created with this IPAM.
resource_discovery_association_countintegerThe count of resource discoveries associated with this IPAM.
descriptionstring
public_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
private_default_scope_idstringThe Id of the default scope for publicly routable IP space, created with this IPAM.
scope_countintegerThe number of scopes that currently exist in this IPAM.
operating_regionsarrayThe regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tierstringThe tier of the IPAM.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all ipams in a region.

SELECT
region,
ipam_id
FROM aws.ec2.ipams_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the ipams_list_only resource, see ipams