Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. VpcIpamPool
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.VpcIpamPool

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an IP address pool resource for IPAM.

    Example Usage

    Basic usage:

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getRegion({});
const example = new aws.ec2.VpcIpam("example", {operatingRegions: [{
    regionName: current.then(current => current.name),
}]});
const exampleVpcIpamPool = new aws.ec2.VpcIpamPool("example", {
    addressFamily: "ipv4",
    ipamScopeId: example.privateDefaultScopeId,
    locale: current.then(current => current.name),
});

    import pulumi
import pulumi_aws as aws

current = aws.get_region()
example = aws.ec2.VpcIpam("example", operating_regions=[{
    "region_name": current.name,
}])
example_vpc_ipam_pool = aws.ec2.VpcIpamPool("example",
    address_family="ipv4",
    ipam_scope_id=example.private_default_scope_id,
    locale=current.name)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetRegion(ctx, &aws.GetRegionArgs{}, nil)
		if err != nil {
			return err
		}
		example, err := ec2.NewVpcIpam(ctx, "example", &ec2.VpcIpamArgs{
			OperatingRegions: ec2.VpcIpamOperatingRegionArray{
				&ec2.VpcIpamOperatingRegionArgs{
					RegionName: pulumi.String(current.Name),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPool(ctx, "example", &ec2.VpcIpamPoolArgs{
			AddressFamily: pulumi.String("ipv4"),
			IpamScopeId:   example.PrivateDefaultScopeId,
			Locale:        pulumi.String(current.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var current = Aws.GetRegion.Invoke();

    var example = new Aws.Ec2.VpcIpam("example", new()
    {
        OperatingRegions = new[]
        {
            new Aws.Ec2.Inputs.VpcIpamOperatingRegionArgs
            {
                RegionName = current.Apply(getRegionResult => getRegionResult.Name),
            },
        },
    });

    var exampleVpcIpamPool = new Aws.Ec2.VpcIpamPool("example", new()
    {
        AddressFamily = "ipv4",
        IpamScopeId = example.PrivateDefaultScopeId,
        Locale = current.Apply(getRegionResult => getRegionResult.Name),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.ec2.VpcIpam;
import com.pulumi.aws.ec2.VpcIpamArgs;
import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
import com.pulumi.aws.ec2.VpcIpamPool;
import com.pulumi.aws.ec2.VpcIpamPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = AwsFunctions.getRegion();

        var example = new VpcIpam("example", VpcIpamArgs.builder()
            .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                .regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
                .build())
            .build());

        var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
            .addressFamily("ipv4")
            .ipamScopeId(example.privateDefaultScopeId())
            .locale(current.applyValue(getRegionResult -> getRegionResult.name()))
            .build());

    }
}

    resources:
  example:
    type: aws:ec2:VpcIpam
    properties:
      operatingRegions:
        - regionName: ${current.name}
  exampleVpcIpamPool:
    type: aws:ec2:VpcIpamPool
    name: example
    properties:
      addressFamily: ipv4
      ipamScopeId: ${example.privateDefaultScopeId}
      locale: ${current.name}
variables:
  current:
    fn::invoke:
      function: aws:getRegion
      arguments: {}

    Nested Pools:

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const current = aws.getRegion({});
const example = new aws.ec2.VpcIpam("example", {operatingRegions: [{
    regionName: current.then(current => current.name),
}]});
const parent = new aws.ec2.VpcIpamPool("parent", {
    addressFamily: "ipv4",
    ipamScopeId: example.privateDefaultScopeId,
});
const parentTest = new aws.ec2.VpcIpamPoolCidr("parent_test", {
    ipamPoolId: parent.id,
    cidr: "172.20.0.0/16",
});
const child = new aws.ec2.VpcIpamPool("child", {
    addressFamily: "ipv4",
    ipamScopeId: example.privateDefaultScopeId,
    locale: current.then(current => current.name),
    sourceIpamPoolId: parent.id,
});
const childTest = new aws.ec2.VpcIpamPoolCidr("child_test", {
    ipamPoolId: child.id,
    cidr: "172.20.0.0/24",
});

    import pulumi
import pulumi_aws as aws

current = aws.get_region()
example = aws.ec2.VpcIpam("example", operating_regions=[{
    "region_name": current.name,
}])
parent = aws.ec2.VpcIpamPool("parent",
    address_family="ipv4",
    ipam_scope_id=example.private_default_scope_id)
parent_test = aws.ec2.VpcIpamPoolCidr("parent_test",
    ipam_pool_id=parent.id,
    cidr="172.20.0.0/16")
child = aws.ec2.VpcIpamPool("child",
    address_family="ipv4",
    ipam_scope_id=example.private_default_scope_id,
    locale=current.name,
    source_ipam_pool_id=parent.id)
child_test = aws.ec2.VpcIpamPoolCidr("child_test",
    ipam_pool_id=child.id,
    cidr="172.20.0.0/24")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := aws.GetRegion(ctx, &aws.GetRegionArgs{}, nil)
		if err != nil {
			return err
		}
		example, err := ec2.NewVpcIpam(ctx, "example", &ec2.VpcIpamArgs{
			OperatingRegions: ec2.VpcIpamOperatingRegionArray{
				&ec2.VpcIpamOperatingRegionArgs{
					RegionName: pulumi.String(current.Name),
				},
			},
		})
		if err != nil {
			return err
		}
		parent, err := ec2.NewVpcIpamPool(ctx, "parent", &ec2.VpcIpamPoolArgs{
			AddressFamily: pulumi.String("ipv4"),
			IpamScopeId:   example.PrivateDefaultScopeId,
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPoolCidr(ctx, "parent_test", &ec2.VpcIpamPoolCidrArgs{
			IpamPoolId: parent.ID(),
			Cidr:       pulumi.String("172.20.0.0/16"),
		})
		if err != nil {
			return err
		}
		child, err := ec2.NewVpcIpamPool(ctx, "child", &ec2.VpcIpamPoolArgs{
			AddressFamily:    pulumi.String("ipv4"),
			IpamScopeId:      example.PrivateDefaultScopeId,
			Locale:           pulumi.String(current.Name),
			SourceIpamPoolId: parent.ID(),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPoolCidr(ctx, "child_test", &ec2.VpcIpamPoolCidrArgs{
			IpamPoolId: child.ID(),
			Cidr:       pulumi.String("172.20.0.0/24"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var current = Aws.GetRegion.Invoke();

    var example = new Aws.Ec2.VpcIpam("example", new()
    {
        OperatingRegions = new[]
        {
            new Aws.Ec2.Inputs.VpcIpamOperatingRegionArgs
            {
                RegionName = current.Apply(getRegionResult => getRegionResult.Name),
            },
        },
    });

    var parent = new Aws.Ec2.VpcIpamPool("parent", new()
    {
        AddressFamily = "ipv4",
        IpamScopeId = example.PrivateDefaultScopeId,
    });

    var parentTest = new Aws.Ec2.VpcIpamPoolCidr("parent_test", new()
    {
        IpamPoolId = parent.Id,
        Cidr = "172.20.0.0/16",
    });

    var child = new Aws.Ec2.VpcIpamPool("child", new()
    {
        AddressFamily = "ipv4",
        IpamScopeId = example.PrivateDefaultScopeId,
        Locale = current.Apply(getRegionResult => getRegionResult.Name),
        SourceIpamPoolId = parent.Id,
    });

    var childTest = new Aws.Ec2.VpcIpamPoolCidr("child_test", new()
    {
        IpamPoolId = child.Id,
        Cidr = "172.20.0.0/24",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.aws.ec2.VpcIpam;
import com.pulumi.aws.ec2.VpcIpamArgs;
import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
import com.pulumi.aws.ec2.VpcIpamPool;
import com.pulumi.aws.ec2.VpcIpamPoolArgs;
import com.pulumi.aws.ec2.VpcIpamPoolCidr;
import com.pulumi.aws.ec2.VpcIpamPoolCidrArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = AwsFunctions.getRegion();

        var example = new VpcIpam("example", VpcIpamArgs.builder()
            .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                .regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
                .build())
            .build());

        var parent = new VpcIpamPool("parent", VpcIpamPoolArgs.builder()
            .addressFamily("ipv4")
            .ipamScopeId(example.privateDefaultScopeId())
            .build());

        var parentTest = new VpcIpamPoolCidr("parentTest", VpcIpamPoolCidrArgs.builder()
            .ipamPoolId(parent.id())
            .cidr("172.20.0.0/16")
            .build());

        var child = new VpcIpamPool("child", VpcIpamPoolArgs.builder()
            .addressFamily("ipv4")
            .ipamScopeId(example.privateDefaultScopeId())
            .locale(current.applyValue(getRegionResult -> getRegionResult.name()))
            .sourceIpamPoolId(parent.id())
            .build());

        var childTest = new VpcIpamPoolCidr("childTest", VpcIpamPoolCidrArgs.builder()
            .ipamPoolId(child.id())
            .cidr("172.20.0.0/24")
            .build());

    }
}

    resources:
  example:
    type: aws:ec2:VpcIpam
    properties:
      operatingRegions:
        - regionName: ${current.name}
  parent:
    type: aws:ec2:VpcIpamPool
    properties:
      addressFamily: ipv4
      ipamScopeId: ${example.privateDefaultScopeId}
  parentTest:
    type: aws:ec2:VpcIpamPoolCidr
    name: parent_test
    properties:
      ipamPoolId: ${parent.id}
      cidr: 172.20.0.0/16
  child:
    type: aws:ec2:VpcIpamPool
    properties:
      addressFamily: ipv4
      ipamScopeId: ${example.privateDefaultScopeId}
      locale: ${current.name}
      sourceIpamPoolId: ${parent.id}
  childTest:
    type: aws:ec2:VpcIpamPoolCidr
    name: child_test
    properties:
      ipamPoolId: ${child.id}
      cidr: 172.20.0.0/24
variables:
  current:
    fn::invoke:
      function: aws:getRegion
      arguments: {}

    Create VpcIpamPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcIpamPool(name: string, args: VpcIpamPoolArgs, opts?: CustomResourceOptions);
    @overload
def VpcIpamPool(resource_name: str,
                args: VpcIpamPoolArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def VpcIpamPool(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                address_family: Optional[str] = None,
                ipam_scope_id: Optional[str] = None,
                allocation_min_netmask_length: Optional[int] = None,
                allocation_max_netmask_length: Optional[int] = None,
                allocation_resource_tags: Optional[Mapping[str, str]] = None,
                auto_import: Optional[bool] = None,
                aws_service: Optional[str] = None,
                cascade: Optional[bool] = None,
                description: Optional[str] = None,
                allocation_default_netmask_length: Optional[int] = None,
                locale: Optional[str] = None,
                public_ip_source: Optional[str] = None,
                publicly_advertisable: Optional[bool] = None,
                source_ipam_pool_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewVpcIpamPool(ctx *Context, name string, args VpcIpamPoolArgs, opts ...ResourceOption) (*VpcIpamPool, error)
    public VpcIpamPool(string name, VpcIpamPoolArgs args, CustomResourceOptions? opts = null)
    public VpcIpamPool(String name, VpcIpamPoolArgs args)
public VpcIpamPool(String name, VpcIpamPoolArgs args, CustomResourceOptions options)

    type: aws:ec2:VpcIpamPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcIpamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcIpamPoolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcIpamPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcIpamPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcIpamPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vpcIpamPoolResource = new Aws.Ec2.VpcIpamPool("vpcIpamPoolResource", new()
{
    AddressFamily = "string",
    IpamScopeId = "string",
    AllocationMinNetmaskLength = 0,
    AllocationMaxNetmaskLength = 0,
    AllocationResourceTags = 
    {
        { "string", "string" },
    },
    AutoImport = false,
    AwsService = "string",
    Cascade = false,
    Description = "string",
    AllocationDefaultNetmaskLength = 0,
    Locale = "string",
    PublicIpSource = "string",
    PubliclyAdvertisable = false,
    SourceIpamPoolId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := ec2.NewVpcIpamPool(ctx, "vpcIpamPoolResource", &ec2.VpcIpamPoolArgs{
	AddressFamily:              pulumi.String("string"),
	IpamScopeId:                pulumi.String("string"),
	AllocationMinNetmaskLength: pulumi.Int(0),
	AllocationMaxNetmaskLength: pulumi.Int(0),
	AllocationResourceTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutoImport:                     pulumi.Bool(false),
	AwsService:                     pulumi.String("string"),
	Cascade:                        pulumi.Bool(false),
	Description:                    pulumi.String("string"),
	AllocationDefaultNetmaskLength: pulumi.Int(0),
	Locale:                         pulumi.String("string"),
	PublicIpSource:                 pulumi.String("string"),
	PubliclyAdvertisable:           pulumi.Bool(false),
	SourceIpamPoolId:               pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var vpcIpamPoolResource = new VpcIpamPool("vpcIpamPoolResource", VpcIpamPoolArgs.builder()
    .addressFamily("string")
    .ipamScopeId("string")
    .allocationMinNetmaskLength(0)
    .allocationMaxNetmaskLength(0)
    .allocationResourceTags(Map.of("string", "string"))
    .autoImport(false)
    .awsService("string")
    .cascade(false)
    .description("string")
    .allocationDefaultNetmaskLength(0)
    .locale("string")
    .publicIpSource("string")
    .publiclyAdvertisable(false)
    .sourceIpamPoolId("string")
    .tags(Map.of("string", "string"))
    .build());

    vpc_ipam_pool_resource = aws.ec2.VpcIpamPool("vpcIpamPoolResource",
    address_family="string",
    ipam_scope_id="string",
    allocation_min_netmask_length=0,
    allocation_max_netmask_length=0,
    allocation_resource_tags={
        "string": "string",
    },
    auto_import=False,
    aws_service="string",
    cascade=False,
    description="string",
    allocation_default_netmask_length=0,
    locale="string",
    public_ip_source="string",
    publicly_advertisable=False,
    source_ipam_pool_id="string",
    tags={
        "string": "string",
    })

    const vpcIpamPoolResource = new aws.ec2.VpcIpamPool("vpcIpamPoolResource", {
    addressFamily: "string",
    ipamScopeId: "string",
    allocationMinNetmaskLength: 0,
    allocationMaxNetmaskLength: 0,
    allocationResourceTags: {
        string: "string",
    },
    autoImport: false,
    awsService: "string",
    cascade: false,
    description: "string",
    allocationDefaultNetmaskLength: 0,
    locale: "string",
    publicIpSource: "string",
    publiclyAdvertisable: false,
    sourceIpamPoolId: "string",
    tags: {
        string: "string",
    },
});

    type: aws:ec2:VpcIpamPool
properties:
    addressFamily: string
    allocationDefaultNetmaskLength: 0
    allocationMaxNetmaskLength: 0
    allocationMinNetmaskLength: 0
    allocationResourceTags:
        string: string
    autoImport: false
    awsService: string
    cascade: false
    description: string
    ipamScopeId: string
    locale: string
    publicIpSource: string
    publiclyAdvertisable: false
    sourceIpamPoolId: string
    tags:
        string: string

    VpcIpamPool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpcIpamPool resource accepts the following input properties:

    AddressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    IpamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    AllocationDefaultNetmaskLength int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    AllocationMaxNetmaskLength int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    AllocationMinNetmaskLength int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    AllocationResourceTags Dictionary<string, string>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    AutoImport bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    AwsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    Cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    Description string
    A description for the IPAM pool.
    Locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    PublicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    PubliclyAdvertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    SourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AddressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    IpamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    AllocationDefaultNetmaskLength int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    AllocationMaxNetmaskLength int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    AllocationMinNetmaskLength int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    AllocationResourceTags map[string]string
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    AutoImport bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    AwsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    Cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    Description string
    A description for the IPAM pool.
    Locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    PublicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    PubliclyAdvertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    SourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addressFamily String
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    ipamScopeId String
    The ID of the scope in which you would like to create the IPAM pool.
    allocationDefaultNetmaskLength Integer
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength Integer
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength Integer
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags Map<String,String>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    autoImport Boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService String
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade Boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description String
    A description for the IPAM pool.
    locale String
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    publicIpSource String
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable Boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId String
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    ipamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    allocationDefaultNetmaskLength number
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength number
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength number
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags {[key: string]: string}
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    autoImport boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description string
    A description for the IPAM pool.
    locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    publicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    address_family str
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    ipam_scope_id str
    The ID of the scope in which you would like to create the IPAM pool.
    allocation_default_netmask_length int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocation_max_netmask_length int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocation_min_netmask_length int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocation_resource_tags Mapping[str, str]
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    auto_import bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    aws_service str
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description str
    A description for the IPAM pool.
    locale str
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    public_ip_source str
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publicly_advertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    source_ipam_pool_id str
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    addressFamily String
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    ipamScopeId String
    The ID of the scope in which you would like to create the IPAM pool.
    allocationDefaultNetmaskLength Number
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength Number
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength Number
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags Map<String>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    autoImport Boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService String
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade Boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description String
    A description for the IPAM pool.
    locale String
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    publicIpSource String
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable Boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId String
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcIpamPool resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of IPAM
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamScopeType string
    PoolDepth int
    State string
    The ID of the IPAM
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of IPAM
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamScopeType string
    PoolDepth int
    State string
    The ID of the IPAM
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of IPAM
    id String
    The provider-assigned unique ID for this managed resource.
    ipamScopeType String
    poolDepth Integer
    state String
    The ID of the IPAM
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of IPAM
    id string
    The provider-assigned unique ID for this managed resource.
    ipamScopeType string
    poolDepth number
    state string
    The ID of the IPAM
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of IPAM
    id str
    The provider-assigned unique ID for this managed resource.
    ipam_scope_type str
    pool_depth int
    state str
    The ID of the IPAM
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of IPAM
    id String
    The provider-assigned unique ID for this managed resource.
    ipamScopeType String
    poolDepth Number
    state String
    The ID of the IPAM
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing VpcIpamPool Resource

    Get an existing VpcIpamPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VpcIpamPoolState, opts?: CustomResourceOptions): VpcIpamPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        allocation_default_netmask_length: Optional[int] = None,
        allocation_max_netmask_length: Optional[int] = None,
        allocation_min_netmask_length: Optional[int] = None,
        allocation_resource_tags: Optional[Mapping[str, str]] = None,
        arn: Optional[str] = None,
        auto_import: Optional[bool] = None,
        aws_service: Optional[str] = None,
        cascade: Optional[bool] = None,
        description: Optional[str] = None,
        ipam_scope_id: Optional[str] = None,
        ipam_scope_type: Optional[str] = None,
        locale: Optional[str] = None,
        pool_depth: Optional[int] = None,
        public_ip_source: Optional[str] = None,
        publicly_advertisable: Optional[bool] = None,
        source_ipam_pool_id: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> VpcIpamPool
    func GetVpcIpamPool(ctx *Context, name string, id IDInput, state *VpcIpamPoolState, opts ...ResourceOption) (*VpcIpamPool, error)
    public static VpcIpamPool Get(string name, Input<string> id, VpcIpamPoolState? state, CustomResourceOptions? opts = null)
    public static VpcIpamPool get(String name, Output<String> id, VpcIpamPoolState state, CustomResourceOptions options)
    resources:  _:    type: aws:ec2:VpcIpamPool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AddressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    AllocationDefaultNetmaskLength int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    AllocationMaxNetmaskLength int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    AllocationMinNetmaskLength int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    AllocationResourceTags Dictionary<string, string>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    Arn string
    Amazon Resource Name (ARN) of IPAM
    AutoImport bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    AwsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    Cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    Description string
    A description for the IPAM pool.
    IpamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    IpamScopeType string
    Locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    PoolDepth int
    PublicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    PubliclyAdvertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    SourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    State string
    The ID of the IPAM
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AddressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    AllocationDefaultNetmaskLength int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    AllocationMaxNetmaskLength int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    AllocationMinNetmaskLength int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    AllocationResourceTags map[string]string
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    Arn string
    Amazon Resource Name (ARN) of IPAM
    AutoImport bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    AwsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    Cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    Description string
    A description for the IPAM pool.
    IpamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    IpamScopeType string
    Locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    PoolDepth int
    PublicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    PubliclyAdvertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    SourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    State string
    The ID of the IPAM
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    addressFamily String
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    allocationDefaultNetmaskLength Integer
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength Integer
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength Integer
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags Map<String,String>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    arn String
    Amazon Resource Name (ARN) of IPAM
    autoImport Boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService String
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade Boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description String
    A description for the IPAM pool.
    ipamScopeId String
    The ID of the scope in which you would like to create the IPAM pool.
    ipamScopeType String
    locale String
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    poolDepth Integer
    publicIpSource String
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable Boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId String
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    state String
    The ID of the IPAM
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    addressFamily string
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    allocationDefaultNetmaskLength number
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength number
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength number
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags {[key: string]: string}
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    arn string
    Amazon Resource Name (ARN) of IPAM
    autoImport boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService string
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description string
    A description for the IPAM pool.
    ipamScopeId string
    The ID of the scope in which you would like to create the IPAM pool.
    ipamScopeType string
    locale string
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    poolDepth number
    publicIpSource string
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId string
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    state string
    The ID of the IPAM
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    address_family str
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    allocation_default_netmask_length int
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocation_max_netmask_length int
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocation_min_netmask_length int
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocation_resource_tags Mapping[str, str]
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    arn str
    Amazon Resource Name (ARN) of IPAM
    auto_import bool
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    aws_service str
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade bool
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description str
    A description for the IPAM pool.
    ipam_scope_id str
    The ID of the scope in which you would like to create the IPAM pool.
    ipam_scope_type str
    locale str
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    pool_depth int
    public_ip_source str
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publicly_advertisable bool
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    source_ipam_pool_id str
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    state str
    The ID of the IPAM
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    addressFamily String
    The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.
    allocationDefaultNetmaskLength Number
    A 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 (unless you provide a different netmask value when you create the new allocation).
    allocationMaxNetmaskLength Number
    The maximum netmask length that will be required for CIDR allocations in this pool.
    allocationMinNetmaskLength Number
    The minimum netmask length that will be required for CIDR allocations in this pool.
    allocationResourceTags Map<String>
    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. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
    arn String
    Amazon Resource Name (ARN) of IPAM
    autoImport Boolean
    If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.
    awsService String
    Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.
    cascade Boolean
    Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.
    description String
    A description for the IPAM pool.
    ipamScopeId String
    The ID of the scope in which you would like to create the IPAM pool.
    ipamScopeType String
    locale String
    The locale in which you would like to create the IPAM pool. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. Possible values: Any AWS region, such as us-east-1.
    poolDepth Number
    publicIpSource String
    The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Valid values are byoip or amazon. Default is byoip.
    publiclyAdvertisable Boolean
    Defines whether or not IPv6 pool space is publicly advertisable over the internet. This argument is required if address_family = "ipv6" and public_ip_source = "byoip", default is false. This option is not available for IPv4 pool space or if public_ip_source = "amazon". Setting this argument to true when it is not available may result in erroneous differences being reported.
    sourceIpamPoolId String
    The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.
    state String
    The ID of the IPAM
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import IPAMs using the IPAM pool id. For example:

    $ pulumi import aws:ec2/vpcIpamPool:VpcIpamPool example ipam-pool-0958f95207d978e1e

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws