ipam

Gets or updates an individual ipam resource, use ipams to retrieve a list of resources or to create or delete a resource.

Overview

Name	ipam
Type	Resource
Description	Resource Schema of AWS::EC2::IPAM Type
Id	aws.ec2.ipam

Fields

Name	Datatype	Description
ipam_id	string	Id of the IPAM.
arn	string	The Amazon Resource Name (ARN) of the IPAM.
default_resource_discovery_id	string	The Id of the default resource discovery, created with this IPAM.
default_resource_discovery_association_id	string	The Id of the default association to the default resource discovery, created with this IPAM.
resource_discovery_association_count	integer	The count of resource discoveries associated with this IPAM.
description	string
public_default_scope_id	string	The Id of the default scope for publicly routable IP space, created with this IPAM.
private_default_scope_id	string	The Id of the default scope for publicly routable IP space, created with this IPAM.
scope_count	integer	The number of scopes that currently exist in this IPAM.
operating_regions	array	The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
tier	string	The tier of the IPAM.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT 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 aws.ec2.ipam
WHERE region = 'us-east-1' AND 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