Class SubnetConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / SubnetConfig

Virtual Private Cloud (VPC) subnet configuration. Use this configuration to define subnets for your VPC. A subnet is a range of IP addresses in your VPC that can be used to create AWS resources, such as EC2 instances.

Example

Static CIDR:

- name: accelerator-cidr-subnet-a
  availabilityZone: a
  routeTable: accelerator-cidr-subnet-a
  ipv4CidrBlock: 10.0.0.0/26
  tags: []

Using the Physical ID for an Availibility Zone

- name: accelerator-cidr-subnet-a
  availabilityZone: 1
  routeTable: accelerator-cidr-subnet-a
  ipv4CidrBlock: 10.0.0.0/26
  tags: []

IPAM allocation:

- name: accelerator-ipam-subnet-a
  availabilityZone: a
  routeTable: accelerator-cidr-subnet-a
  ipamAllocation:
    ipamPoolName: accelerator-regional-pool
    netmaskLength: 26
  tags: []

Hierarchy

  • SubnetConfig

Implements

Constructors

constructor

Properties

availabilityZone ipamAllocation ipv4CidrBlock mapPublicIpOnLaunch name outpost routeTable shareTargets tags

Constructors

constructor

Properties

Readonly availabilityZone

availabilityZone: undefined | string | number = undefined

The Availability Zone (AZ) the subnet resides in.

Remarks

CAUTION: changing this property after initial deployment will cause a subnet recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Include only the letter of the AZ name (i.e. 'a' for 'us-east-1a') to have the subnet created in a specific AZ. Use an integer (i.e. 1) for a physical mapping ID to an AZ. Please reference the documentation Availability Zone IDs for your AWS resources for more information.

Readonly ipamAllocation

ipamAllocation: undefined | IpamAllocationConfig = undefined

The IPAM pool configuration for the subnet.

See

Remarks

Must be using AWS-managed IPAM and allocate a CIDR to the VPC this subnet will be created in. Define IPAM configuration in centralNetworkServices.

Readonly ipv4CidrBlock

ipv4CidrBlock: undefined | string = undefined

The IPv4 CIDR block to associate with the subnet.

Remarks

CAUTION: changing this property after initial deployment will cause a subnet recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Use CIDR notation, i.e. 10.0.0.0/16

Readonly mapPublicIpOnLaunch

mapPublicIpOnLaunch: undefined | boolean = undefined

(OPTIONAL) Configure automatic mapping of public IPs.

Remarks

Enables you to configure the auto-assign IP settings to automatically request a public IPv4 address for a new network interface in this subnet.

Readonly name

name: string = ''

A friendly name for the VPC subnet.

Remarks

CAUTION: changing this property after initial deployment will cause a subnet recreation. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly outpost

outpost: undefined | string = undefined

(OPTIONAL) The friendly name for the outpost to attach to the subnet

Remarks

This is the logical name of the outpost as defined in network-config.yaml.

See

OutpostsConfig

Readonly routeTable

routeTable: undefined | string = undefined

The friendly name of the route table to associate with the subnet.

Readonly shareTargets

shareTargets: undefined | ShareTargets = undefined

(OPTIONAL) Resource Access Manager (RAM) share targets.

Remarks

NOTE: When sharing subnets, security groups created in this VPC will be automatically replicated to the share target accounts. If tags are configured for the VPC and/or subnet, they are also replicated.

See

Targets can be account names and/or organizational units.

Readonly tags

tags: undefined | Tag[] = undefined

(OPTIONAL) An array of tag objects for the VPC subnet.

Settings

Member Visibility

Theme

Generated using TypeDoc