Interface IVpcTemplatesConfig

NetworkConfig / VpcTemplatesConfig

Virtual Private Cloud (VPC) templates configuration.

Description

Use this configuration to define a VPC using a standard configuration that is deployed to multiple account(s)/OU(s) defined using a deploymentTargets property. With Amazon Virtual Private Cloud (Amazon VPC), you can launch AWS resources in a logically isolated virtual network that you've defined. This virtual network closely resembles a traditional network that you'd operate in your own data center, with the benefits of using the scalable infrastructure of AWS.

Static CIDR:

vpcTemplates:
  - name: Accelerator-Template
    deploymentTargets:
      organizationalUnits:
        - Infrastructure
    region: us-east-1
    cidrs:
      - 10.0.0.0/24
    enableDnsHostnames: true
    enableDnsSupport: true
    instanceTenancy: default
    routeTables: []
    subnets: []
    natGateways: []
    transitGatewayAttachments: []
    tags: []

IPAM allocation:

vpcTemplates:
  - name: Accelerator-Template
    deploymentTargets:
      organizationalUnits:
        - Infrastructure
    region: us-east-1
    ipamAllocations:
      - ipamPoolName: accelerator-regional-pool
        netmaskLength: 24
    enableDnsHostnames: true
    enableDnsSupport: true
    instanceTenancy: default
    routeTables: []
    subnets: []
    natGateways: []
    transitGatewayAttachments: []
    tags: []

Static IPv6 CIDR:

vpcTemplates:
  - name: Accelerator-Template
    deploymentTargets:
      organizationalUnits:
        - Infrastructure
    region: us-east-1
    cidrs:
      - 10.0.0.0/24
    ipv6Cidrs:
      - amazonProvided: true
    enableDnsHostnames: true
    enableDnsSupport: true
    instanceTenancy: default
    routeTables: []
    subnets: []
    natGateways: []
    transitGatewayAttachments: []
    tags: []

interface IVpcTemplatesConfig {
    name: string;
    region: string;
    deploymentTargets: IDeploymentTargets;
    cidrs?: string[];
    defaultSecurityGroupRulesDeletion?: boolean;
    dhcpOptions?: string;
    dnsFirewallRuleGroups?: IVpcDnsFirewallAssociationConfig[];
    egressOnlyIgw?: boolean;
    enableDnsHostnames?: boolean;
    enableDnsSupport?: boolean;
    gatewayEndpoints?: IGatewayEndpointConfig;
    instanceTenancy?: InstanceTenancyType;
    ipv6Cidrs?: IVpcIpv6Config[];
    interfaceEndpoints?: IInterfaceEndpointConfig;
    internetGateway?: boolean;
    ipamAllocations?: IIpamAllocationConfig[];
    natGateways?: INatGatewayConfig[];
    useCentralEndpoints?: boolean;
    securityGroups?: ISecurityGroupConfig[];
    networkAcls?: INetworkAclConfig[];
    queryLogs?: string[];
    resolverRules?: string[];
    routeTables?: IRouteTableConfig[];
    subnets?: ISubnetConfig[];
    transitGatewayAttachments?: ITransitGatewayAttachmentConfig[];
    virtualPrivateGateway?: IVirtualPrivateGatewayConfig;
    tags?: ITag[];
    vpcFlowLogs?: IVpcFlowLogsConfig;
    loadBalancers?: ILoadBalancersConfig;
    targetGroups?: ITargetGroupItem[];
}

Properties

`Readonly`name

name: string

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.

Remarks

CAUTION: Changing this property value after initial deployment causes the VPC to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

`Readonly`region

region: string

The AWS region to deploy the VPCs to

`Readonly`deploymentTargets

deploymentTargets: IDeploymentTargets

VPC deployment targets.

Remarks

Targets can be account names and/or organizational units. The excludedRegions property is ignored for VPC templates, as a VPC template can only be deployed to a single region.

See

DeploymentTargets

`Optional` `Readonly`cidrs

cidrs?: string[]

(OPTIONAL) A list of IPv4 CIDRs to associate with the VPC.

Remarks

CAUTION: Changing or removing an existing CIDR value after initial deployment causes the VPC to be recreated. Please be aware that any downstream dependencies may cause this property update to fail. You can add additional CIDRs to the VPC without this recreation occurring.

NOTE: Expanding a VPC with additional CIDRs is subject to these restrictions.

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

Use IPv4 CIDR notation, i.e. 10.0.0.0/16

`Optional` `Readonly`defaultSecurityGroupRulesDeletion

defaultSecurityGroupRulesDeletion?: boolean

(OPTIONAL) Determine if the all traffic ingress and egress rules are deleted in the default security group of a VPC.

Remarks

If the defaultSecurityGroupRulesDeletion parameter is set to true, the solution will proceed in removing the default ingress and egress All Traffic (0.0.0.0/0) for that respective VPC's default security group.

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/default-custom-security-groups.html#default-security-group

`Optional` `Readonly`dhcpOptions

dhcpOptions?: string

(OPTIONAL) The friendly name of a custom DHCP options set.

Remarks

This is the logical name property of the DHCP options set as defined in network-config.yaml.

See

DhcpOptsConfig

`Optional` `Readonly`dnsFirewallRuleGroups

dnsFirewallRuleGroups?: IVpcDnsFirewallAssociationConfig[]

(OPTIONAL) An array of DNS firewall VPC association configurations. Use this property to associate Route 53 resolver DNS firewall rule groups with the VPC.

See

NetworkConfigTypes.vpcDnsFirewallAssociationConfig
DnsFirewallRuleGroupConfig

Remarks

The DNS firewall rule groups must be deployed in the same region of the VPC and shareTargets must be configured to capture the account(s)/OU(s) that this VPC template is deployed to. If deploying this VPC to the delegated admin account, shareTargets is not required for that account.

`Optional` `Readonly`egressOnlyIgw

egressOnlyIgw?: boolean

(OPTIONAL) Create an Egress-only internet gateway (EIGW) for the VPC

`Optional` `Readonly`enableDnsHostnames

enableDnsHostnames?: boolean

Enable DNS hostname support for the VPC.

See

https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html

`Optional` `Readonly`enableDnsSupport

enableDnsSupport?: boolean

Enable DNS support for the VPC.

See

https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html

`Optional` `Readonly`gatewayEndpoints

gatewayEndpoints?: IGatewayEndpointConfig

(OPTIONAL) An array of gateway endpoints for the VPC. Use this property to define S3 or DynamoDB gateway endpoints for the VPC.

See

GatewayEndpointConfig

`Optional` `Readonly`instanceTenancy

instanceTenancy?: InstanceTenancyType

(OPTIONAL) Define instance tenancy for the VPC. The default value is default.

See

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html

`Optional` `Readonly`ipv6Cidrs

ipv6Cidrs?: IVpcIpv6Config[]

(OPTIONAL) An array of IPv6 CIDR block configurations.

See

VpcIpv6Config

Remarks

CAUTION: Changing or removing an existing IPv6 CIDR block may cause unexpected behavior if there are subnets provisioned using the CIDR. Please be aware that any downstream dependencies may cause this property update to fail. You can add additional IPv6 CIDR blocks to the VPC without interruptions occurring.

At least one IPv4 static CIDR or IPAM allocation MUST be configured along with any IPv6 CIDR blocks. A VPC cannot be created without an IPv4 CIDR.

`Optional` `Readonly`interfaceEndpoints

interfaceEndpoints?: IInterfaceEndpointConfig

(OPTIONAL) A list of VPC interface endpoints. Use this property to define VPC interface endpoints for the VPC.

See

InterfaceEndpointConfig

`Optional` `Readonly`internetGateway

internetGateway?: boolean

Defines if an internet gateway should be added to the VPC

`Optional` `Readonly`ipamAllocations

ipamAllocations?: IIpamAllocationConfig[]

(OPTIONAL) An array of IPAM allocation configurations.

See

IpamAllocationConfig
IpamPoolConfig

Remarks

CAUTION: Changing or removing an existing IPAM allocation value after initial deployment causes the VPC to be recreated. Please be aware that any downstream dependencies may cause this property update to fail. You can add additional IPAM allocations to the VPC without this recreation occurring.

NOTE: Expanding a VPC with additional CIDRs is subject to these restrictions.

IPAM pools defined in network-config.yaml must be deployed to the same region of the VPC and shareTargets must be configured to capture the account(s)/OU(s) that this VPC template is deployed to. If deploying this VPC to the delegated admin account, shareTargets is not required for that account.

`Optional` `Readonly`natGateways

natGateways?: INatGatewayConfig[]

(OPTIONAL) An array of NAT gateway configurations for the VPC. Use this property to configure the NAT gateways for the VPC.

See

NatGatewayConfig

`Optional` `Readonly`useCentralEndpoints

useCentralEndpoints?: boolean

(OPTIONAL) 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

Remarks

A VPC deployed in the same region as this VPC in network-config.yaml must be configured with InterfaceEndpointConfig central property set to true to utilize centralized endpoints.

`Optional` `Readonly`securityGroups

securityGroups?: ISecurityGroupConfig[]

(OPTIONAL) A list of Security Groups to deploy for this VPC

Default

undefined

`Optional` `Readonly`networkAcls

networkAcls?: INetworkAclConfig[]

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

Default

undefined

See

NetworkAclConfig

`Optional` `Readonly`queryLogs

queryLogs?: string[]

(OPTIONAL) A list of DNS query log configuration names.

Remarks

This is the logical name property of the Route 53 resolver query logs configuration as defined in network-config.yaml. The shareTargets property must be configured to capture the account(s)/OUs that this VPC template is deployed to. If deploying this VPC to the delegated admin account, shareTargets is not required for that account.

See

DnsQueryLogsConfig

`Optional` `Readonly`resolverRules

resolverRules?: string[]

(OPTIONAL) A list of Route 53 resolver rule names.

Remarks

This is the logical name property of the Route 53 resolver rules configuration as defined in network-config.yaml. The shareTargets property must be configured to capture the account(s)/OUs that this VPC template is deployed to. If deploying this VPC to the delegated admin account, shareTargets is not required for that account.

See

ResolverRuleConfig

`Optional` `Readonly`routeTables

routeTables?: IRouteTableConfig[]

(OPTIONAL) An array of route table configurations for the VPC. Use this property to configure the route tables for the VPC.

See

RouteTableConfig

`Optional` `Readonly`subnets

subnets?: ISubnetConfig[]

(OPTIONAL) An array of subnet configurations for the VPC. Use this property to configure the subnets for the VPC.

See

SubnetConfig

`Optional` `Readonly`transitGatewayAttachments

transitGatewayAttachments?: ITransitGatewayAttachmentConfig[]

(OPTIONAL) An array of Transit Gateway attachment configurations. Use this property to configure the Transit Gateway attachments for the VPC.

See

TransitGatewayAttachmentConfig

`Optional` `Readonly`virtualPrivateGateway

virtualPrivateGateway?: IVirtualPrivateGatewayConfig

(OPTIONAL) Virtual Private Gateway configuration. Use this property to configure a Virtual Private Gateway for the VPC.

Default

undefined

`Optional` `Readonly`tags

tags?: ITag[]

(OPTIONAL) A list of tags to apply to this VPC

Default

undefined

`Optional` `Readonly`vpcFlowLogs

vpcFlowLogs?: IVpcFlowLogsConfig

VPC flog log configuration. Use this property to define a VPC-specific VPC flow logs configuration.

Remarks

If defined, this configuration is preferred over a global VPC flow logs configuration.

See

VpcFlowLogsConfig

`Optional` `Readonly`loadBalancers

loadBalancers?: ILoadBalancersConfig

Elastic Load Balancing configuration. Use this property to define Elastic Load Balancers for this VPC.

See

LoadBalancersConfig

`Optional` `Readonly`targetGroups

targetGroups?: ITargetGroupItem[]

Target group configuration. Use this property to define target groups for this VPC.

See

TargetGroupItemConfig

Interface IVpcTemplatesConfig

Description

Index

Properties

Properties

Readonlyname

Remarks

Readonlyregion

ReadonlydeploymentTargets

Remarks

See

Optional Readonlycidrs

Remarks

Optional ReadonlydefaultSecurityGroupRulesDeletion

Remarks

See

Optional ReadonlydhcpOptions

Remarks

See

Optional ReadonlydnsFirewallRuleGroups

See

Remarks

Optional ReadonlyegressOnlyIgw

Optional ReadonlyenableDnsHostnames

See

Optional ReadonlyenableDnsSupport

See

Optional ReadonlygatewayEndpoints

See

Optional ReadonlyinstanceTenancy

See

Optional Readonlyipv6Cidrs

See

Remarks

Optional ReadonlyinterfaceEndpoints

See

Optional ReadonlyinternetGateway

Optional ReadonlyipamAllocations

See

Remarks

Optional ReadonlynatGateways

See

Optional ReadonlyuseCentralEndpoints

Default

Remarks

Optional ReadonlysecurityGroups

Default

Optional ReadonlynetworkAcls

Default

See

Optional ReadonlyqueryLogs

Remarks

See

Optional ReadonlyresolverRules

Remarks

See

Optional ReadonlyrouteTables

See

Optional Readonlysubnets

See

Optional ReadonlytransitGatewayAttachments

See

Optional ReadonlyvirtualPrivateGateway

Default

Optional Readonlytags

Default

Optional ReadonlyvpcFlowLogs

Remarks

See

Optional ReadonlyloadBalancers

See

Optional ReadonlytargetGroups

See

Settings

On This Page

`Readonly`name

`Readonly`region

`Readonly`deploymentTargets

`Optional` `Readonly`cidrs

`Optional` `Readonly`defaultSecurityGroupRulesDeletion

`Optional` `Readonly`dhcpOptions

`Optional` `Readonly`dnsFirewallRuleGroups

`Optional` `Readonly`egressOnlyIgw

`Optional` `Readonly`enableDnsHostnames

`Optional` `Readonly`enableDnsSupport

`Optional` `Readonly`gatewayEndpoints

`Optional` `Readonly`instanceTenancy

`Optional` `Readonly`ipv6Cidrs

`Optional` `Readonly`interfaceEndpoints

`Optional` `Readonly`internetGateway

`Optional` `Readonly`ipamAllocations

`Optional` `Readonly`natGateways

`Optional` `Readonly`useCentralEndpoints

`Optional` `Readonly`securityGroups

`Optional` `Readonly`networkAcls

`Optional` `Readonly`queryLogs

`Optional` `Readonly`resolverRules

`Optional` `Readonly`routeTables

`Optional` `Readonly`subnets

`Optional` `Readonly`transitGatewayAttachments

`Optional` `Readonly`virtualPrivateGateway

`Optional` `Readonly`tags

`Optional` `Readonly`vpcFlowLogs

`Optional` `Readonly`loadBalancers

`Optional` `Readonly`targetGroups