ipam_scopes

Creates, updates, deletes or gets an ipam_scope resource or lists ipam_scopes in a region

Overview

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

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
create_resource	INSERT	IpamId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all ipam_scopes in a region.

SELECT
region,
ipam_scope_id,
arn,
ipam_id,
ipam_arn,
ipam_scope_type,
is_default,
description,
pool_count,
tags
FROM aws.ec2.ipam_scopes
WHERE region = 'us-east-1';

Gets all properties from an individual ipam_scope.

SELECT
region,
ipam_scope_id,
arn,
ipam_id,
ipam_arn,
ipam_scope_type,
is_default,
description,
pool_count,
tags
FROM aws.ec2.ipam_scopes
WHERE region = 'us-east-1' AND data__Identifier = '<IpamScopeId>';

INSERT example

Use the following StackQL query and manifest file to create a new ipam_scope resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ec2.ipam_scopes (
 IpamId,
 region
)
SELECT 
'{{ IpamId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ec2.ipam_scopes (
 IpamId,
 Description,
 Tags,
 region
)
SELECT 
 '{{ IpamId }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: ipam_scope
    props:
      - name: IpamId
        value: '{{ IpamId }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ec2.ipam_scopes
WHERE data__Identifier = '<IpamScopeId>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateIpamScope,
ec2:DescribeIpamScopes,
ec2:CreateTags

Read

ec2:DescribeIpamScopes

Update

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

Delete

ec2:DeleteIpamScope,
ec2:DescribeIpamScopes,
ec2:DeleteTags

List

ec2:DescribeIpamScopes