AwsIpamPoolResourceArgs

interface AwsIpamPoolResourceArgs { addressFamily?: Input<string>; allocationDefaultNetmaskLength?: Input<number>; allocationMaxNetmaskLength?: Input<number>; allocationMinNetmaskLength?: Input<number>; allocationResourceTags?: Input<Record<string, Input<string>>>; autoImport?: Input<boolean>; cascade?: Input<boolean>; cidrs?: Record<string, AwsIpamPoolCidrArgs>; description?: Input<string>; ipam?: AwsIpamIpamReference; ipamId?: Input<string>; ipamScopeId?: Input<string>; locale?: Input<string>; name: string; parentPool?: AwsIpamPoolReference; parentPoolId?: Input<string>; ramResourceShare?: AwsRamResourceShareReference; ramResourceShareName?: Input<string>; scope?: 'private' | 'public'; tags?: Input<Record<string, Input<string>>>; }

Input arguments for the pool capability.


Properties

addressFamily: Input<string>

Address family for the pool.

Default: `ipv4`

allocationDefaultNetmaskLength: Input<number>

Optional default allocation netmask length.

allocationMaxNetmaskLength: Input<number>

Optional maximum allocation netmask length.

allocationMinNetmaskLength: Input<number>

Optional minimum allocation netmask length.

allocationResourceTags: Input<Record<string, Input<string>>>

Optional allocation resource tags enforced by IPAM.

autoImport: Input<boolean>

Optional auto-import behaviour for matching resources.

cascade: Input<boolean>

Optional cascade deletion behaviour.

cidrs: Record<string, AwsIpamPoolCidrArgs>

Optional pool CIDRs to provision as child resources.

Remarks

Keys are CIDR values and therefore the stable logical identity for each child resource. Values are empty objects and must be supplied as a literal keyed record to keep preview deterministic.

description: Input<string>

Optional pool description.

ipam: AwsIpamIpamReference

IPAM reference used for private/public default scope resolution.

ipamId: Input<string>

Optional IPAM ID retained for compatibility.

Remarks

This value is not used to resolve pool scope IDs. When provided, also provide ipam and do not set ipamScopeId.

ipamScopeId: Input<string>

Explicit scope ID override.

Remarks

Mutually exclusive with scope resolution via ipam.

locale: Input<string>

Optional locale for allocations from this pool.

name: string

Purpose used to build canonical stackAndPurpose naming for pool tags.

Remarks

This value is required and must resolve to a non-empty string.

parentPool: AwsIpamPoolReference

Parent pool reference for nested pools.

parentPoolId: Input<string>

Explicit parent pool ID for nested pools.

ramResourceShare: AwsRamResourceShareReference

Optional RAM resource-share reference for pool association.

Remarks

Provide an AwsRam or explicit { arn } reference. Raw aws.ram.ResourceShare resources are not accepted. Mutually exclusive with ramResourceShareName.

ramResourceShareName: Input<string>

Optional RAM resource-share name for pool association.

Remarks

Resolved through RAM lookup as an active SELF share. Mutually exclusive with ramResourceShare.

scope: 'private' | 'public'

Scope selector used when resolving scope ID from ipam.

Default: `private`

tags: Input<Record<string, Input<string>>>

Optional tags merged with default project/environment tags.