pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/VpcIpamPool

VpcIpamPool

class VpcIpamPool : KotlinCustomResource

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=[aws.ec2.VpcIpamOperatingRegionArgs(
    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)

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 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, nil, 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
	})
}

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=[aws.ec2.VpcIpamOperatingRegionArgs(
    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")

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 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, nil, 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
	})
}

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: {}

Import

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

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

Properties

addressFamily

val addressFamily: Output<String>

The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool.

allocationDefaultNetmaskLength

val allocationDefaultNetmaskLength: Output<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

val allocationMaxNetmaskLength: Output<Int>?

The maximum netmask length that will be required for CIDR allocations in this pool.

allocationMinNetmaskLength

val allocationMinNetmaskLength: Output<Int>?

The minimum netmask length that will be required for CIDR allocations in this pool.

allocationResourceTags

val allocationResourceTags: Output<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

val arn: Output<String>

Amazon Resource Name (ARN) of IPAM

autoImport

val autoImport: Output<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

val awsService: Output<String>?

Limits which AWS service the pool can be used in. Only useable on public scopes. Valid Values: ec2.

cascade

val cascade: Output<Boolean>?

Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.

description

val description: Output<String>?

A description for the IPAM pool.

val id: Output<String>

ipamScopeId

val ipamScopeId: Output<String>

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

ipamScopeType

val ipamScopeType: Output<String>

locale

val locale: Output<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

val poolDepth: Output<Int>

publicIpSource

val publicIpSource: Output<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

val publiclyAdvertisable: Output<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".

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sourceIpamPoolId

val sourceIpamPoolId: Output<String>?

The ID of the source IPAM pool. Use this argument to create a child pool within an existing pool.

state

val state: Output<String>

The ID of the IPAM