Interface CcIpamPoolProps

CloudKitect IPAM Pool Component Properties

interface CcIpamPoolProps {
    addressFamily?: CcIpamAddressFamily;
    allocationDefaultNetmaskLength?: number;
    allocationMaxNetmaskLength?: number;
    allocationMinNetmaskLength?: number;
    autoImport?: boolean;
    description?: string;
    ipamScopeId: string;
    locale?: CcRegion;
    provisionedCidrs?: CcCidr[];
    publicIpSource?: CcPublicIpSource;
    sourceIpamPoolId?: string;
    tags?: CcTag[];
}

Properties

addressFamily?: CcIpamAddressFamily

The address family of the pool.

Default

CcIpamAddressFamily.IPV4
allocationDefaultNetmaskLength?: number

The default netmask length for allocations added to this pool, If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here new allocations will default to 10.0.0.0/16.

Default

24
allocationMaxNetmaskLength?: number

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

allocationMinNetmaskLength?: number

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

autoImport?: boolean

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

Default

true
description?: string

The description of the IPAM pool.

ipamScopeId: string

The ID of the scope in which you would like to create the IPAM pool.

locale?: CcRegion

The locale of the IPAM pool. In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations.

provisionedCidrs?: CcCidr[]

Information about the CIDRs provisioned to an IPAM pool.

publicIpSource?: CcPublicIpSource

The IP address source for pools in the public scope.

sourceIpamPoolId?: string

The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

tags?: CcTag[]

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool.

Generated using TypeDoc