Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VpcConfig

NetworkConfig / VpcConfig

VPC configuration. Used to define a VPC.

example

Static CIDR:

vpcs:
  - name: Network-Inspection
    account: Network
    region: us-east-1
    cidrs:
      - 10.0.0.0/24
    enableDnsHostnames: true
    enableDnsSupport: true
    instanceTenancy: default
    routeTables: []
    subnets: []
    natGateways: []
    transitGatewayAttachments: []
    tags: []

IPAM allocation:

vpcs:
  - name: Network-Inspection
    account: Network
    region: us-east-1
    ipamAllocations:
      - ipamPoolName: accelerator-regional-pool
        netmaskLength: 24
    enableDnsHostnames: true
    enableDnsSupport: true
    instanceTenancy: default
    routeTables: []
    subnets: []
    natGateways: []
    transitGatewayAttachments: []
    tags: []

Hierarchy

  • VpcConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly account

account: "" = ''

The logical name of the account to deploy the VPC to

Readonly cidrs

cidrs: undefined | string[] = undefined

A list of CIDRs to associate with the VPC.

remarks

At least one CIDR should be provided if not using ipamAllocations.

Use CIDR notation, i.e. 10.0.0.0/16

Readonly dhcpOptions

dhcpOptions: undefined | string = undefined

The friendly name of a DHCP options set.

Readonly dnsFirewallRuleGroups

dnsFirewallRuleGroups: undefined | { mutationProtection: undefined | "ENABLED" | "DISABLED"; name: string; priority: number; tags: undefined | { key: string; value: string; }[] }[] = undefined

An array of DNS firewall VPC association configurations.

see

NetworkConfigTypes.vpcDnsFirewallAssociationConfig

Readonly enableDnsHostnames

enableDnsHostnames: undefined | boolean = true

Enable DNS hostname support for the VPC.

Readonly enableDnsSupport

enableDnsSupport: undefined | boolean = true

Enable DNS support for the VPC.

Readonly gatewayEndpoints

gatewayEndpoints: undefined | GatewayEndpointConfig = undefined

An array of gateway endpoints for the VPC.

Readonly instanceTenancy

instanceTenancy: undefined | "default" | "dedicated" = 'default'

Define instance tenancy for the VPC.

Readonly interfaceEndpoints

interfaceEndpoints: undefined | InterfaceEndpointConfig = undefined

A list of VPC interface endpoints.

Readonly internetGateway

internetGateway: undefined | boolean = undefined

Defines if an internet gateway should be added to the VPC

Readonly ipamAllocations

ipamAllocations: undefined | IpamAllocationConfig[] = undefined

An optional array of IPAM allocation configurations.

see

IpamAllocationConfig

Readonly loadBalancers

loadBalancers: undefined | LoadBalancersConfig = undefined

Readonly name

name: "" = ''

The friendly name of the VPC.

The value of this property will be utilized as the logical id for this resource. Any references to this object should specify this value.

Readonly natGateways

natGateways: undefined | NatGatewayConfig[] = undefined

An array of NAT gateway configurations for the VPC.

Readonly networkAcls

networkAcls: undefined | NetworkAclConfig[] = undefined

A list of Network Access Control Lists (ACLs) to deploy for this VPC

default

undefined

Readonly outposts

outposts: undefined | OutpostsConfig[] = undefined

An array of Local Gateway Route table configurations.

Readonly prefixLists

prefixLists: undefined | PrefixListConfig[] = undefined

A list of Prefix Lists to deploy for this VPC

default

undefined

Readonly queryLogs

queryLogs: undefined | string[] = undefined

An optional list of DNS query log configuration names.

Readonly region

region: "us-east-1" = 'us-east-1'

The AWS region to deploy the VPC to

Readonly resolverRules

resolverRules: undefined | string[] = undefined

An optional list of Route 53 resolver rule names.

Readonly routeTables

routeTables: undefined | RouteTableConfig[] = undefined

An array of route table configurations for the VPC.

Readonly securityGroups

securityGroups: undefined | SecurityGroupConfig[] = undefined

A list of Security Groups to deploy for this VPC

default

undefined

Readonly subnets

subnets: undefined | SubnetConfig[] = undefined

An array of subnet configurations for the VPC.

Readonly tags

tags: undefined | Tag[] = undefined

A list of tags to apply to this VPC

default

undefined

Readonly targetGroups

targetGroups: undefined | TargetGroupItemConfig[] = undefined

Readonly transitGatewayAttachments

transitGatewayAttachments: undefined | TransitGatewayAttachmentConfig[] = undefined

An array of Transit Gateway attachment configurations.

Readonly useCentralEndpoints

useCentralEndpoints: undefined | boolean = false

When set to true, this VPC will be configured to utilize centralized endpoints. This includes having the Route 53 Private Hosted Zone associated with this VPC. Centralized endpoints are configured per region, and can span to spoke accounts

default

false

Readonly virtualPrivateGateway

virtualPrivateGateway: undefined | VirtualPrivateGatewayConfig = undefined

Virtual Private Gateway configuration

default

undefined

Readonly vpcFlowLogs

vpcFlowLogs: undefined | VpcFlowLogsConfig = undefined

VPC flog log configuration

Generated using TypeDoc