Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubnetConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / SubnetConfig

VPC subnet configuration. Used to define a VPC subnet.

example

Static CIDR:

- name: accelerator-cidr-subnet-a
  availabilityZone: a
  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

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly availabilityZone

availabilityZone: "" = ''

The Availability Zone (AZ) the subnet resides in.

remarks

Include only the letter of the AZ name (i.e. 'a' for 'us-east-1a'). Not needed if providing an outpost

Readonly ipamAllocation

ipamAllocation: undefined | IpamAllocationConfig = undefined

The IPAM pool configuration for the subnet.

see

IpamAllocationConfig

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. @see CentralNetworkServicesConfig

Readonly ipv4CidrBlock

ipv4CidrBlock: undefined | string = undefined

The IPv4 CIDR block to associate with the subnet.

remarks

Use CIDR notation, i.e. 10.0.0.0/16

Readonly mapPublicIpOnLaunch

mapPublicIpOnLaunch: undefined | boolean = undefined

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: "" = ''

A friendly name for the VPC subnet.

Readonly outpost

outpost: undefined | string = undefined

The friendly name for the outpost to attach to the subnet

Readonly routeTable

routeTable: "" = ''

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

Readonly shareTargets

shareTargets: ShareTargets = ...

Resource Access Manager (RAM) share targets.

remarks

Targets can be account names and/or organizational units.

see

{@link t.ShareTargets}

Readonly tags

tags: undefined | Tag[] = undefined

An array of tag objects for the VPC subnet.

Generated using TypeDoc