Class IpamConfig

NetworkConfig / CentralNetworkServicesConfig / IpamConfig

Virtual Private Cloud (VPC) IP Address Manager (IPAM) configuration. Use this configuration to define an AWS-managed VPC IPAM. IPAM is a feature that makes it easier for you to plan, track, and monitor IP addresses for your AWS workloads.

The following example defines an IPAM that is capable of operating in the us-east-1 and us-west-2 regions:

Example

ipams:
  - name: accelerator-ipam
    region: us-east-1
    description: Accelerator IPAM
    operatingRegions:
      - us-east-1
      - us-west-2
    scopes: []
    pools: []
    tags: []

Hierarchy

  • IpamConfig

Implements

Constructors

constructor

Properties

description name operatingRegions pools region scopes tags

Constructors

constructor

Properties

Readonly description

description: undefined | string = undefined

(OPTIONAL) A description for the IPAM.

Readonly name

name: string = ''

A friendly name for the IPAM.

Remarks

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

Readonly operatingRegions

operatingRegions: undefined | string[] = undefined

(OPTIONAL) An array of regions that the IPAM will manage.

Readonly pools

pools: undefined | IpamPoolConfig[] = undefined

An optional array of IPAM pool configurations to create under the IPAM.

See

IpamPoolConfig

Readonly region

region: string = 'us-east-1'

The region to deploy the IPAM.

Remarks

Note that IPAMs must be deployed to a single region but may be used to manage allocations in multiple regions. Configure the operatingRegions property to define multiple regions to manage.

Readonly scopes

scopes: undefined | IpamScopeConfig[] = undefined

(OPTIONAL) An array of IPAM scope configurations to create under the IPAM.

See

IpamScopeConfig

Readonly tags

tags: undefined | Tag[] = undefined

(OPTIONAL) An array of tag objects for the IPAM.

Settings

Member Visibility

Theme

Generated using TypeDoc