Skip to main content

ipam

Gets an individual ipam resource

Overview

Nameipam
TypeResource
Descriptionipam
Idawscc.ec2.ipam

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
ipam_id,
arn,
default_resource_discovery_id,
default_resource_discovery_association_id,
resource_discovery_association_count,
description,
public_default_scope_id,
private_default_scope_id,
scope_count,
operating_regions,
tier,
tags
FROM awscc.ec2.ipam
WHERE data__Identifier = '<IpamId>';

Permissions

To operate on the ipam resource, the following permissions are required:

Read

ec2:DescribeIpams

Update

ec2:ModifyIpam,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeIpams

Delete

ec2:DeleteIpam,
ec2:DeleteTags,
ec2:DescribeIpams