ipam_scope

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

Overview

Name	ipam_scope
Type	Resource
Description	Resource Schema of AWS::EC2::IPAMScope Type
Id	aws.ec2.ipam_scope

Fields

Name	Datatype	Description
ipam_scope_id	string	Id of the IPAM scope.
arn	string	The Amazon Resource Name (ARN) of the IPAM scope.
ipam_id	string	The Id of the IPAM this scope is a part of.
ipam_arn	string	The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
ipam_scope_type	string	Determines whether this scope contains publicly routable space or space for a private network
is_default	boolean	Is this one of the default scopes created with the IPAM.
description	string
pool_count	integer	The number of pools that currently exist in this scope.
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_scope_id,
arn,
ipam_id,
ipam_arn,
ipam_scope_type,
is_default,
description,
pool_count,
tags
FROM aws.ec2.ipam_scope
WHERE region = 'us-east-1' AND data__Identifier = '<IpamScopeId>';

Permissions

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

Read

ec2:DescribeIpamScopes

Update

ec2:ModifyIpamScope,
ec2:DescribeIpamScopes,
ec2:CreateTags,
ec2:DeleteTags