Interface IIpamScopeConfig

NetworkConfig / CentralNetworkServicesConfig / IpamConfig / IpamScopeConfig

VPC IPAM scope configuration.

Description

Use this configuration to define custom private IPAM scopes for your VPCs. An IPAM scope is the highest-level container for an IPAM. Within scopes, pools can be created. Custom IPAM scopes can be used to create pools and manage resources that use the same IP space.

Example

- name: accelerator-scope
  description: Custom scope
  tags: []
interface IIpamScopeConfig {
    description?: string;
    name: string;
    tags?: ITag[];
}

Properties

description? name tags?

Properties

Optional Readonlydescription

description?: string

(OPTIONAL) Description for the IPAM scope.

Readonlyname

name: string

A friendly name for the IPAM scope.

Remarks

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

Optional Readonlytags

tags?: ITag[]

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

Settings

Member Visibility

On This Page

Properties