# VpcProps

Configuration for Vpc.

Extends: VpcProps
Used as props by: Vpc

- Source: [`aws-ec2/lib/vpc.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-ec2/lib/vpc.ts#L949)
- Type last changed: v2.121.0 · 12 Jan 2024

## Example

```ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';

const vpc = new ec2.Vpc(this, 'Vpc', {
  ipAddresses: ec2.IpAddresses.cidr('10.0.0.0/16')
});

const vpcConnector = new apprunner.VpcConnector(this, 'VpcConnector', {
  vpc,
  vpcSubnets: vpc.selectSubnets({ subnetType: ec2.SubnetType.PUBLIC }),
  vpcConnectorName: 'MyVpcConnector',
});

new apprunner.Service(this, 'Service', {
  source: apprunner.Source.fromEcrPublic({
    imageConfiguration: { port: 8000 },
    imageIdentifier: 'public.ecr.aws/aws-containers/hello-app-runner:latest',
  }),
  vpcConnector,
});
```

## Properties

- `availabilityZones`: string[] — Availability zones this VPC spans.

  **Default:** a subset of AZs of the stack

  Specify this option only if you do not specify `maxAzs`.

- `cidr`: string = Vpc.DEFAULT_CIDR_RANGE — Use ipAddresses instead

  Should be a minimum of /28 and maximum size of /16. The range will be
  split across all subnets per Availability Zone.

- `createInternetGateway`: boolean = true — If set to false then disable the creation of the default internet gateway.

- `defaultInstanceTenancy`: [DefaultInstanceTenancy](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.DefaultInstanceTenancy.html) — The default tenancy of instances launched into the VPC.

  **Default:** DefaultInstanceTenancy.Default (shared) tenancy

  By setting this to dedicated tenancy, instances will be launched on
  hardware dedicated to a single AWS customer, unless specifically specified
  at instance launch time. Please note, not all instance types are usable
  with Dedicated tenancy.

- `enableDnsHostnames`: boolean = true — Indicates whether the instances launched in the VPC get public DNS hostnames.

  If this attribute is true, instances in the VPC get public DNS hostnames,
  but only if the enableDnsSupport attribute is also set to true.

- `enableDnsSupport`: boolean = true — Indicates whether the DNS resolution is supported for the VPC.

  If this attribute is false, the Amazon-provided DNS server in the VPC that
  resolves public DNS hostnames to IP addresses is not enabled. If this
  attribute is true, 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 IPv4 network range plus two will succeed.

- `flowLogs`: { [key: string]: [FlowLogOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.FlowLogOptions.html) } — Flow logs to add to this VPC.

  **Default:** No flow logs.

- `gatewayEndpoints`: { [key: string]: [GatewayVpcEndpointOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.GatewayVpcEndpointOptions.html) } = None. — Gateway endpoints to add to this VPC.

- `ipAddresses`: [IIpAddresses](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IIpAddresses.html) = ec2.IpAddresses.cidr — The Provider to use to allocate IPv4 Space to your VPC.

  Options include static allocation or from a pool.

  Note this is specific to IPv4 addresses.

- `ipProtocol`: [IpProtocol](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IpProtocol.html) = IpProtocol.IPV4_ONLY — The protocol of the vpc.

  Options are IPv4 only or dual stack.

- `ipv6Addresses`: [IIpv6Addresses](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IIpv6Addresses.html) = Ipv6Addresses.amazonProvided — The Provider to use to allocate IPv6 Space to your VPC.

  Options include amazon provided CIDR block.

  Note this is specific to IPv6 addresses.

- `maxAzs`: number = 3 — Define the maximum number of AZs to use in this region.

  If the region has more AZs than you want to use (for example, because of
  EIP limits), pick a lower number here. The AZs will be sorted and picked
  from the start of the list.

  If you pick a higher number than the number of AZs in the region, all AZs
  in the region will be selected. To use "all AZs" available to your
  account, use a high number (such as 99).

  Be aware that environment-agnostic stacks will be created with access to
  only 2 AZs, so to use more than 2 AZs, be sure to specify the account and
  region on your stack.

  Specify this option only if you do not specify `availabilityZones`.

- `natGatewayProvider`: [NatProvider](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.NatProvider.html) = NatProvider.gateway() — What type of NAT provider to use.

  Select between NAT gateways or NAT instances. NAT gateways
  may not be available in all AWS regions.

- `natGateways`: number — The number of NAT Gateways/Instances to create.

  **Default:** One NAT gateway/instance per Availability Zone

  The type of NAT gateway or instance will be determined by the
  `natGatewayProvider` parameter.

  You can set this number lower than the number of Availability Zones in your
  VPC in order to save on NAT cost. Be aware you may be charged for
  cross-AZ data traffic instead.

- `natGatewaySubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — Configures the subnets which will have NAT Gateways/Instances.

  **Default:** All public subnets.

  You can pick a specific group of subnets by specifying the group name;
  the picked subnets must be public subnets.

  Only necessary if you have more than one public subnet group.

- `reservedAzs`: number = 0 — Define the number of AZs to reserve.

  When specified, the IP space is reserved for the azs but no actual
  resources are provisioned.

- `restrictDefaultSecurityGroup`: boolean — If set to true then the default inbound & outbound rules will be removed from the default security group.

  **Default:** true if '@aws-cdk/aws-ec2:restrictDefaultSecurityGroup' is enabled, false otherwise

- `subnetConfiguration`: [SubnetConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetConfiguration.html)[] — Configure the subnets to build for each AZ.

  **Default:** The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ.

  Each entry in this list configures a Subnet Group; each group will contain a
  subnet for each Availability Zone.

  For example, if you want 1 public subnet, 1 private subnet, and 1 isolated
  subnet in each AZ provide the following:

  ```ts
  new ec2.Vpc(this, 'VPC', {
    subnetConfiguration: [
       {
         cidrMask: 24,
         name: 'ingress',
         subnetType: ec2.SubnetType.PUBLIC,
       },
       {
         cidrMask: 24,
         name: 'application',
         subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
       },
       {
         cidrMask: 28,
         name: 'rds',
         subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
       }
    ]
  });
  ```

- `vpcName`: string = this.node.path — The VPC name.

  Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag

- `vpnConnections`: { [key: string]: [VpnConnectionOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpnConnectionOptions.html) } — VPN connections to this VPC.

  **Default:** No connections.

- `vpnGateway`: boolean — Indicates whether a VPN gateway should be created and attached to this VPC.

  **Default:** true when vpnGatewayAsn or vpnConnections is specified

- `vpnGatewayAsn`: number — The private Autonomous System Number (ASN) for the VPN gateway.

  **Default:** Amazon default ASN.

- `vpnRoutePropagation`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html)[] — Where to propagate VPN routes.

  **Default:** On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used.