Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IpamPoolConfig

NetworkConfig / CentralNetworkServicesConfig / IpamConfig / IpamPoolConfig

IPAM pool configuration. Used to define an IPAM pool.

example

Base pool:

- name: accelerator-base-pool
  description: Base IPAM pool
  provisionedCidrs:
    - 10.0.0.0/16
  tags: []

Regional pool:

- name: accelerator-regional-pool
  description: Regional pool for us-east-1
  locale: us-east-1
  provisionedCidrs:
    - 10.0.0.0/24
  sourceIpamPool: accelerator-base-pool

Hierarchy

  • IpamPoolConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly addressFamily

addressFamily: undefined | "ipv4" | "ipv6" = 'ipv4'

The address family for the IPAM pool.

see

NetworkConfigTypes.ipVersionEnum

Readonly allocationDefaultNetmaskLength

allocationDefaultNetmaskLength: undefined | number = undefined

The default netmask length of IPAM allocations for this pool.

Readonly allocationMaxNetmaskLength

allocationMaxNetmaskLength: undefined | number = undefined

The maximum netmask length of IPAM allocations for this pool.

Readonly allocationMinNetmaskLength

allocationMinNetmaskLength: undefined | number = undefined

The minimum netmask length of IPAM allocations for this pool.

Readonly allocationResourceTags

allocationResourceTags: undefined | Tag[] = undefined

An optional array of tags that are required for resources that use CIDRs from this IPAM pool.

remarks

Resources that do not have these tags will not be allowed to allocate space from the pool.

Readonly autoImport

autoImport: undefined | boolean = undefined

If set to true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

Readonly description

description: undefined | string = undefined

A description for the IPAM pool.

Readonly locale

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

The AWS Region where you want to make an IPAM pool available for allocations.

remarks

Only resources in the same Region as the locale of the pool can get IP address allocations from the pool.

Readonly name

name: string = ''

A friendly name for the IPAM pool.

Readonly provisionedCidrs

provisionedCidrs: undefined | string[] = undefined

An array of CIDR ranges to provision for the IPAM pool.

remarks

Use CIDR notation, i.e. 10.0.0.0/16

Readonly publiclyAdvertisable

publiclyAdvertisable: undefined | boolean = undefined

Determines if a pool is publicly advertisable.

remarks

This option is not available for pools with AddressFamily set to ipv4.

Readonly scope

scope: undefined | string = undefined

The friendly name of the IPAM scope to assign the IPAM pool to.

remarks

Leave this property undefined to create the pool in the default scope.

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 sourceIpamPool

sourceIpamPool: undefined | string = undefined

The friendly name of the source IPAM pool to create this IPAM pool from.

remarks

Only define this value when creating nested IPAM pools. Leave undefined for top-level pools.

Readonly tags

tags: undefined | Tag[] = undefined

An array of tag objects for the IPAM pool.

Generated using TypeDoc