vpc_cidr_blocks

Used to retrieve a list of vpc_cidr_blocks in a region or to create or delete a vpc_cidr_blocks resource, use vpc_cidr_block to read or update an individual resource.

Overview

Name	vpc_cidr_blocks
Type	Resource
Description	Resource Type definition for AWS::EC2::VPCCidrBlock
Id	aws.ec2.vpc_cidr_blocks

Fields

Name	Datatype	Description
id	string	The Id of the VPC associated CIDR Block.
vpc_id	string	The ID of the VPC.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	VpcId, region
delete_resource	DELETE	data__Identifier, region
list_resource	SELECT	region

SELECT Example

SELECT
region,
id,
vpc_id
FROM aws.ec2.vpc_cidr_blocks
WHERE region = 'us-east-1';

INSERT Example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.ec2.vpc_cidr_blocks (
 CidrBlock,
 Ipv6Pool,
 VpcId,
 Ipv6CidrBlock,
 Ipv4IpamPoolId,
 Ipv4NetmaskLength,
 Ipv6IpamPoolId,
 Ipv6NetmaskLength,
 AmazonProvidedIpv6CidrBlock,
 region
)
SELECT 
 '{{ CidrBlock }}',
 '{{ Ipv6Pool }}',
 '{{ VpcId }}',
 '{{ Ipv6CidrBlock }}',
 '{{ Ipv4IpamPoolId }}',
 '{{ Ipv4NetmaskLength }}',
 '{{ Ipv6IpamPoolId }}',
 '{{ Ipv6NetmaskLength }}',
 '{{ AmazonProvidedIpv6CidrBlock }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc_cidr_block
    props:
      - name: CidrBlock
        value: '{{ CidrBlock }}'
      - name: Ipv6Pool
        value: '{{ Ipv6Pool }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: Ipv6CidrBlock
        value: '{{ Ipv6CidrBlock }}'
      - name: Ipv4IpamPoolId
        value: '{{ Ipv4IpamPoolId }}'
      - name: Ipv4NetmaskLength
        value: '{{ Ipv4NetmaskLength }}'
      - name: Ipv6IpamPoolId
        value: '{{ Ipv6IpamPoolId }}'
      - name: Ipv6NetmaskLength
        value: '{{ Ipv6NetmaskLength }}'
      - name: AmazonProvidedIpv6CidrBlock
        value: '{{ AmazonProvidedIpv6CidrBlock }}'

DELETE Example

/*+ delete */
DELETE FROM aws.ec2.vpc_cidr_blocks
WHERE data__Identifier = '<Id|VpcId>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:AssociateVpcCidrBlock,
ec2:DescribeVpcs,
ec2:AllocateIpamPoolCidr

Delete

ec2:DescribeVpcs,
ec2:DisassociateVpcCidrBlock

List

ec2:DescribeVpcs