AwsVpcIpamArgs

Input arguments for IPAM-driven VPC capability.

Example

import * as awsx from '@pulumi/awsx';
import type { AwsVpcIpamArgs } from '@jobcloud/aws-vpc';

const ipamVpc: AwsVpcIpamArgs = {
  region: 'eu-west-1',
  subnetStrategy: awsx.ec2.SubnetAllocationStrategy.Auto,
};

Hierarchy

• Omit<AwsVpcDirectArgs, "ipv4IpamPoolId">
• AwsVpcIpamArgs

Properties

assignGeneratedIpv6CidrBlock: Input<boolean | undefined>

Inherited from assignGeneratedIpv6CidrBlock

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. Default is false. Conflicts with ipv6IpamPoolId

availabilityZoneCidrMask: number

Inherited from availabilityZoneCidrMask

The netmask for each available zone to be aligned to. This is optional, the default value is inferred based on an even distribution of available space from the VPC's CIDR block after being divided evenly by the number of availability zones.

availabilityZones: AwsVpcAvailabilityZones

Inherited from availabilityZones

Stable, keyed availability zones used for subnet placement and subnet Name-tag child identity.

Remarks

Provide this when the component should create subnet Name tags. Without stable consumer keys the component creates only the VPC Name tag and leaves AWSX-generated subnet names untouched.

enableDnsHostnames: Input<boolean | undefined>

Inherited from enableDnsHostnames

A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false.

enableDnsSupport: Input<boolean | undefined>

Inherited from enableDnsSupport

A boolean flag to enable/disable DNS support in the VPC. Defaults to true.

enableNetworkAddressUsageMetrics: Input<boolean | undefined>

Inherited from enableNetworkAddressUsageMetrics

Indicates whether Network Address Usage metrics are enabled for your VPC. Defaults to false.

instanceTenancy: Input<string | undefined>

Inherited from instanceTenancy

A tenancy option for instances launched into the VPC. Default is default, which ensures that EC2 instances launched in this VPC use the EC2 instance tenancy attribute specified when the EC2 instance is launched. The only other option is dedicated, which ensures that EC2 instances launched in this VPC are run on dedicated tenancy instances regardless of the tenancy attribute specified at launch. This has a dedicated per region fee of $2 per hour, plus an hourly per instance usage fee.

internetGatewayEnabled: boolean

Inherited from internetGatewayEnabled

Whether internet-gateway-backed networking is allowed for this VPC.

Remarks

Set to false for private-only VPC patterns. When disabled, public subnets are rejected and NAT strategy is forced to none.

Default: ```ts true ```

ipv4CidrBlock: string

Inherited from ipv4CidrBlock

Optional explicit IPv4 VPC CIDR block.

Remarks

Set exactly one of ipv4CidrBlock or ipv4IpamPoolId.

ipv4NetmaskLength: Input<number | undefined>

Inherited from ipv4NetmaskLength

The netmask length of the IPv4 CIDR you want to allocate to this VPC. Requires specifying a ipv4IpamPoolId.

ipv6CidrBlock: Input<string | undefined>

Inherited from ipv6CidrBlock

IPv6 CIDR block to request from an IPAM Pool. Can be set explicitly or derived from IPAM using ipv6NetmaskLength.

ipv6CidrBlockNetworkBorderGroup: Input<string | undefined>

Inherited from ipv6CidrBlockNetworkBorderGroup

By default when an IPv6 CIDR is assigned to a VPC a default ipv6CidrBlockNetworkBorderGroup will be set to the region of the VPC. This can be changed to restrict advertisement of public addresses to specific Network Border Groups such as LocalZones.

ipv6IpamPoolId: Input<string | undefined>

Inherited from ipv6IpamPoolId

IPAM Pool ID for a IPv6 pool. Conflicts with assignGeneratedIpv6CidrBlock.

ipv6NetmaskLength: Input<number | undefined>

Inherited from ipv6NetmaskLength

Netmask length to request from IPAM Pool. Conflicts with ipv6CidrBlock. This can be omitted if IPAM pool as a allocationDefaultNetmaskLength set. Valid values are from 44 to 60 in increments of 4.

natGateways: AwsVpcNatGatewayArgs

Inherited from natGateways

Optional NAT gateway configuration.

region: Input<string>

Overrides region

AWS region used for IPAM pool selection.

Remarks

When set to a plain string, availabilityZones values are additionally validated against the availability zones known for this region.

When omitted, the region is resolved via aws.getRegionOutput, using the component's options.provider when one is supplied so IPAM pool selection targets the same region as the provider-backed lookups.

Default: The region of the component's `options.provider`, or the ambient default provider region when no provider is supplied, resolved via `aws.getRegionOutput`.

subnetNameTagStrategy: SubnetNameTagStrategy

Inherited from subnetNameTagStrategy

Controls the AWS Name tags applied to generated subnets and their associated route tables. Pulumi logical resource names and URNs are unchanged. Optional; defaults to Legacy.

subnetSpecs: AwsVpcSubnetSpecs

Inherited from subnetSpecs

Optional stable, keyed subnet specifications.

subnetStrategy: SubnetAllocationStrategy

Inherited from subnetStrategy

Optional subnet allocation strategy.

Default: `auto`

tags: Input<Record<string, Input<string>>>

Inherited from tags

Optional tags merged with default ${namespace}:project and ${namespace}:env tags.

Remarks

The Name key is reserved: the VPC Name tag is derived from args.name, so passing a Name key here is rejected. When tags is a plain object the rejection is synchronous at construction; when it is a pulumi.Input (Output/promise) the rejection surfaces when the value resolves.

vpcEndpointSpecs: VpcEndpointSpecArgs[]

Inherited from vpcEndpointSpecs

A list of VPC Endpoints specs to be deployed as part of the VPC

vpcEndpointStrategy: VpcEndpointStrategy

Inherited from vpcEndpointStrategy

The strategy to use when applying VPC endpoint specs. Optional. Defaults to Legacy.