Skip to main content

vpc

Gets an individual vpc resource

Overview

Namevpc
TypeResource
Descriptionvpc
Idawscc.ec2.vpc

Fields

NameDatatypeDescription
vpc_idstring
cidr_blockstringThe 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``.
cidr_block_associationsarray
default_network_aclstring
default_security_groupstring
ipv6_cidr_blocksarray
enable_dns_hostnamesbooleanIndicates 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.
enable_dns_supportbooleanIndicates 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).
instance_tenancystringThe 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_ipam_pool_idstringThe 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``.
ipv4_netmask_lengthintegerThe 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*.
tagsarrayThe tags for the VPC.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
vpc_id,
cidr_block,
cidr_block_associations,
default_network_acl,
default_security_group,
ipv6_cidr_blocks,
enable_dns_hostnames,
enable_dns_support,
instance_tenancy,
ipv4_ipam_pool_id,
ipv4_netmask_length,
tags
FROM awscc.ec2.vpc
WHERE data__Identifier = '<VpcId>';

Permissions

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

Read

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

Update

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

Delete

ec2:DeleteVpc,
ec2:DescribeVpcs