Class IpamConfig

NetworkConfig / CentralNetworkServicesConfig / IpamConfig

IPAM configuration. Used to define an AWS-managed VPC IPAM.

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

A description for the IPAM.

Readonly name

name: string = ''

A friendly name for the IPAM.

Readonly operatingRegions

operatingRegions: undefined | ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "cn-north-1" | "cn-northwest-1" | "eu-central-2" | "ap-south-2" | "us-gov-west-1" | "us-gov-east-1" | "us-iso-east-1" | "us-iso-west-1" | "us-isob-east-1" | "ap-southeast-4")[] = undefined

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: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ca-central-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "cn-north-1" | "cn-northwest-1" | "eu-central-2" | "ap-south-2" | "us-gov-west-1" | "us-gov-east-1" | "us-iso-east-1" | "us-iso-west-1" | "us-isob-east-1" | "ap-southeast-4" = 'us-east-1'

The region to deploy the IPAM.

Remarks

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

Readonly scopes

scopes: undefined | IpamScopeConfig[] = undefined

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

See

IpamScopeConfig

Readonly tags

tags: undefined | Tag[] = undefined

An array of tag objects for the IPAM.

Settings

Member Visibility

Theme

Generated using TypeDoc