vpcs

Creates, updates, deletes or gets a vpc resource or lists vpcs in a region

Overview

Name	`vpcs`
Type	Resource
Description	Specifies a virtual private cloud (VPC). To add an IPv6 CIDR block to the VPC, see [AWS::EC2::VPCCidrBlock](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpccidrblock.html). For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the Amazon VPC User Guide.
Id	`awscc.ec2.vpcs`

Fields

Name	Datatype	Description
`vpc_id`	`string`
`instance_tenancy`	`string`	The allowed tenancy of instances launched into the VPC.<br />+ ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.<br />+ ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.<br /><br />Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
`ipv4_netmask_length`	`integer`	The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM User Guide.
`cidr_block_associations`	`array`
`cidr_block`	`string`	The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.<br />You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
`ipv4_ipam_pool_id`	`string`	The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the Amazon VPC IPAM User Guide.<br />You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
`default_network_acl`	`string`
`enable_dns_support`	`boolean`	Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
`ipv6_cidr_blocks`	`array`
`default_security_group`	`string`
`enable_dns_hostnames`	`boolean`	Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).<br />You can only enable DNS hostnames if you've enabled DNS support.
▶`tags`	`array`	The tags for the VPC.
`region`	`string`	AWS region.

For more information, see AWS::EC2::VPC.

Methods

Name	Accessible by	Required Params
`create_resource`	`INSERT`	`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 properties from an individual vpc.

SELECT
region,
vpc_id,
instance_tenancy,
ipv4_netmask_length,
cidr_block_associations,
cidr_block,
ipv4_ipam_pool_id,
default_network_acl,
enable_dns_support,
ipv6_cidr_blocks,
default_security_group,
enable_dns_hostnames,
tags
FROM awscc.ec2.vpcs
WHERE region = 'us-east-1' AND data__Identifier = '<VpcId>';

`INSERT` example

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

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.ec2.vpcs (
 InstanceTenancy,
 Ipv4NetmaskLength,
 CidrBlock,
 Ipv4IpamPoolId,
 EnableDnsSupport,
 EnableDnsHostnames,
 Tags,
 region
)
SELECT 
'{{ InstanceTenancy }}',
 '{{ Ipv4NetmaskLength }}',
 '{{ CidrBlock }}',
 '{{ Ipv4IpamPoolId }}',
 '{{ EnableDnsSupport }}',
 '{{ EnableDnsHostnames }}',
 '{{ Tags }}',
'{{ region }}';

/*+ create */
INSERT INTO awscc.ec2.vpcs (
 InstanceTenancy,
 Ipv4NetmaskLength,
 CidrBlock,
 Ipv4IpamPoolId,
 EnableDnsSupport,
 EnableDnsHostnames,
 Tags,
 region
)
SELECT 
 '{{ InstanceTenancy }}',
 '{{ Ipv4NetmaskLength }}',
 '{{ CidrBlock }}',
 '{{ Ipv4IpamPoolId }}',
 '{{ EnableDnsSupport }}',
 '{{ EnableDnsHostnames }}',
 '{{ Tags }}',
 '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: vpc
    props:
      - name: InstanceTenancy
        value: '{{ InstanceTenancy }}'
      - name: Ipv4NetmaskLength
        value: '{{ Ipv4NetmaskLength }}'
      - name: CidrBlock
        value: '{{ CidrBlock }}'
      - name: Ipv4IpamPoolId
        value: '{{ Ipv4IpamPoolId }}'
      - name: EnableDnsSupport
        value: '{{ EnableDnsSupport }}'
      - name: EnableDnsHostnames
        value: '{{ EnableDnsHostnames }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

`DELETE` example

/*+ delete */
DELETE FROM awscc.ec2.vpcs
WHERE data__Identifier = '<VpcId>'
AND region = 'us-east-1';

Permissions

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

Read

ec2:DescribeVpcs,
ec2:DescribeSecurityGroups,
ec2:DescribeNetworkAcls,
ec2:DescribeVpcAttribute

Create

ec2:CreateVpc,
ec2:DescribeVpcs,
ec2:DescribeVpcAttribute,
ec2:ModifyVpcAttribute,
ec2:CreateTags

Update

ec2:CreateTags,
ec2:ModifyVpcAttribute,
ec2:DescribeVpcAttribute,
ec2:DeleteTags,
ec2:ModifyVpcTenancy

List

ec2:DescribeVpcs

Delete

ec2:DeleteVpc,
ec2:DescribeVpcs

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​

Permissions​

Read​

Create​

Update​

List​

Delete​