VpcIpamPoolCidrAllocation class

Allocates (reserves) a CIDR from an IPAM address pool, preventing usage by IPAM. Only works for private IPv4.

Example Usage

Basic usage:

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

const current = aws.getRegion({});
const exampleVpcIpam = new aws.ec2.VpcIpam("example", {operatingRegions: [{
    regionName: current.then(current => current.region),
}]});
const exampleVpcIpamPool = new aws.ec2.VpcIpamPool("example", {
    addressFamily: "ipv4",
    ipamScopeId: exampleVpcIpam.privateDefaultScopeId,
    locale: current.then(current => current.region),
});
const exampleVpcIpamPoolCidr = new aws.ec2.VpcIpamPoolCidr("example", {
    ipamPoolId: exampleVpcIpamPool.id,
    cidr: "172.20.0.0/16",
});
const example = new aws.ec2.VpcIpamPoolCidrAllocation("example", {
    ipamPoolId: exampleVpcIpamPool.id,
    cidr: "172.20.0.0/24",
}, {
    dependsOn: [exampleVpcIpamPoolCidr],
});
import pulumi
import pulumi_aws as aws

current = aws.get_region()
example_vpc_ipam = aws.ec2.VpcIpam("example", operating_regions=[{
    "region_name": current.region,
}])
example_vpc_ipam_pool = aws.ec2.VpcIpamPool("example",
    address_family="ipv4",
    ipam_scope_id=example_vpc_ipam.private_default_scope_id,
    locale=current.region)
example_vpc_ipam_pool_cidr = aws.ec2.VpcIpamPoolCidr("example",
    ipam_pool_id=example_vpc_ipam_pool.id,
    cidr="172.20.0.0/16")
example = aws.ec2.VpcIpamPoolCidrAllocation("example",
    ipam_pool_id=example_vpc_ipam_pool.id,
    cidr="172.20.0.0/24",
    opts = pulumi.ResourceOptions(depends_on=[example_vpc_ipam_pool_cidr]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

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

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

    var exampleVpcIpamPoolCidr = new Aws.Ec2.VpcIpamPoolCidr("example", new()
    {
        IpamPoolId = exampleVpcIpamPool.Id,
        Cidr = "172.20.0.0/16",
    });

    var example = new Aws.Ec2.VpcIpamPoolCidrAllocation("example", new()
    {
        IpamPoolId = exampleVpcIpamPool.Id,
        Cidr = "172.20.0.0/24",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleVpcIpamPoolCidr,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v7/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
		}
		exampleVpcIpam, err := ec2.NewVpcIpam(ctx, "example", &ec2.VpcIpamArgs{
			OperatingRegions: ec2.VpcIpamOperatingRegionArray{
				&ec2.VpcIpamOperatingRegionArgs{
					RegionName: pulumi.String(current.Region),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleVpcIpamPool, err := ec2.NewVpcIpamPool(ctx, "example", &ec2.VpcIpamPoolArgs{
			AddressFamily: pulumi.String("ipv4"),
			IpamScopeId:   exampleVpcIpam.PrivateDefaultScopeId,
			Locale:        pulumi.String(current.Region),
		})
		if err != nil {
			return err
		}
		exampleVpcIpamPoolCidr, err := ec2.NewVpcIpamPoolCidr(ctx, "example", &ec2.VpcIpamPoolCidrArgs{
			IpamPoolId: exampleVpcIpamPool.ID().ToIDOutput().ToStringOutput(),
			Cidr:       pulumi.String("172.20.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPoolCidrAllocation(ctx, "example", &ec2.VpcIpamPoolCidrAllocationArgs{
			IpamPoolId: exampleVpcIpamPool.ID().ToIDOutput().ToStringOutput(),
			Cidr:       pulumi.String("172.20.0.0/24"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleVpcIpamPoolCidr,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_getregion" "current" {
}

resource "aws_ec2_vpcipampoolcidrallocation" "example" {
  depends_on   = [aws_ec2_vpcipampoolcidr.example]
  ipam_pool_id = aws_ec2_vpcipampool.example.id
  cidr         = "172.20.0.0/24"
}
resource "aws_ec2_vpcipampoolcidr" "example" {
  ipam_pool_id = aws_ec2_vpcipampool.example.id
  cidr         = "172.20.0.0/16"
}
resource "aws_ec2_vpcipampool" "example" {
  address_family = "ipv4"
  ipam_scope_id  = aws_ec2_vpcipam.example.private_default_scope_id
  locale         = data.aws_getregion.current.region
}
resource "aws_ec2_vpcipam" "example" {
  operating_regions {
    region_name = data.aws_getregion.current.region
  }
}
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 com.pulumi.aws.ec2.VpcIpamPoolCidrAllocation;
import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocationArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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(GetRegionArgs.builder()
            .build());

        var exampleVpcIpam = new VpcIpam("exampleVpcIpam", VpcIpamArgs.builder()
            .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                .regionName(current.region())
                .build())
            .build());

        var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
            .addressFamily("ipv4")
            .ipamScopeId(exampleVpcIpam.privateDefaultScopeId())
            .locale(current.region())
            .build());

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

        var example = new VpcIpamPoolCidrAllocation("example", VpcIpamPoolCidrAllocationArgs.builder()
            .ipamPoolId(exampleVpcIpamPool.id())
            .cidr("172.20.0.0/24")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleVpcIpamPoolCidr)
                .build());

    }
}
resources:
  example:
    type: aws:ec2:VpcIpamPoolCidrAllocation
    properties:
      ipamPoolId: ${exampleVpcIpamPool.id}
      cidr: 172.20.0.0/24
    options:
      dependsOn:
        - ${exampleVpcIpamPoolCidr}
  exampleVpcIpamPoolCidr:
    type: aws:ec2:VpcIpamPoolCidr
    name: example
    properties:
      ipamPoolId: ${exampleVpcIpamPool.id}
      cidr: 172.20.0.0/16
  exampleVpcIpamPool:
    type: aws:ec2:VpcIpamPool
    name: example
    properties:
      addressFamily: ipv4
      ipamScopeId: ${exampleVpcIpam.privateDefaultScopeId}
      locale: ${current.region}
  exampleVpcIpam:
    type: aws:ec2:VpcIpam
    name: example
    properties:
      operatingRegions:
        - regionName: ${current.region}
variables:
  current:
    fn::invoke:
      function: aws:getRegion
      arguments: {}

With the disallowedCidrs attribute:

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

const current = aws.getRegion({});
const exampleVpcIpam = new aws.ec2.VpcIpam("example", {operatingRegions: [{
    regionName: current.then(current => current.region),
}]});
const exampleVpcIpamPool = new aws.ec2.VpcIpamPool("example", {
    addressFamily: "ipv4",
    ipamScopeId: exampleVpcIpam.privateDefaultScopeId,
    locale: current.then(current => current.region),
});
const exampleVpcIpamPoolCidr = new aws.ec2.VpcIpamPoolCidr("example", {
    ipamPoolId: exampleVpcIpamPool.id,
    cidr: "172.20.0.0/16",
});
const example = new aws.ec2.VpcIpamPoolCidrAllocation("example", {
    ipamPoolId: exampleVpcIpamPool.id,
    netmaskLength: 28,
    disallowedCidrs: ["172.20.0.0/28"],
}, {
    dependsOn: [exampleVpcIpamPoolCidr],
});
import pulumi
import pulumi_aws as aws

current = aws.get_region()
example_vpc_ipam = aws.ec2.VpcIpam("example", operating_regions=[{
    "region_name": current.region,
}])
example_vpc_ipam_pool = aws.ec2.VpcIpamPool("example",
    address_family="ipv4",
    ipam_scope_id=example_vpc_ipam.private_default_scope_id,
    locale=current.region)
example_vpc_ipam_pool_cidr = aws.ec2.VpcIpamPoolCidr("example",
    ipam_pool_id=example_vpc_ipam_pool.id,
    cidr="172.20.0.0/16")
example = aws.ec2.VpcIpamPoolCidrAllocation("example",
    ipam_pool_id=example_vpc_ipam_pool.id,
    netmask_length=28,
    disallowed_cidrs=["172.20.0.0/28"],
    opts = pulumi.ResourceOptions(depends_on=[example_vpc_ipam_pool_cidr]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

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

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

    var exampleVpcIpamPoolCidr = new Aws.Ec2.VpcIpamPoolCidr("example", new()
    {
        IpamPoolId = exampleVpcIpamPool.Id,
        Cidr = "172.20.0.0/16",
    });

    var example = new Aws.Ec2.VpcIpamPoolCidrAllocation("example", new()
    {
        IpamPoolId = exampleVpcIpamPool.Id,
        NetmaskLength = 28,
        DisallowedCidrs = new[]
        {
            "172.20.0.0/28",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleVpcIpamPoolCidr,
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v7/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
		}
		exampleVpcIpam, err := ec2.NewVpcIpam(ctx, "example", &ec2.VpcIpamArgs{
			OperatingRegions: ec2.VpcIpamOperatingRegionArray{
				&ec2.VpcIpamOperatingRegionArgs{
					RegionName: pulumi.String(current.Region),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleVpcIpamPool, err := ec2.NewVpcIpamPool(ctx, "example", &ec2.VpcIpamPoolArgs{
			AddressFamily: pulumi.String("ipv4"),
			IpamScopeId:   exampleVpcIpam.PrivateDefaultScopeId,
			Locale:        pulumi.String(current.Region),
		})
		if err != nil {
			return err
		}
		exampleVpcIpamPoolCidr, err := ec2.NewVpcIpamPoolCidr(ctx, "example", &ec2.VpcIpamPoolCidrArgs{
			IpamPoolId: exampleVpcIpamPool.ID().ToIDOutput().ToStringOutput(),
			Cidr:       pulumi.String("172.20.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPoolCidrAllocation(ctx, "example", &ec2.VpcIpamPoolCidrAllocationArgs{
			IpamPoolId:    exampleVpcIpamPool.ID().ToIDOutput().ToStringOutput(),
			NetmaskLength: pulumi.Int(28),
			DisallowedCidrs: pulumi.StringArray{
				pulumi.String("172.20.0.0/28"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleVpcIpamPoolCidr,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_getregion" "current" {
}

resource "aws_ec2_vpcipampoolcidrallocation" "example" {
  depends_on       = [aws_ec2_vpcipampoolcidr.example]
  ipam_pool_id     = aws_ec2_vpcipampool.example.id
  netmask_length   = 28
  disallowed_cidrs = ["172.20.0.0/28"]
}
resource "aws_ec2_vpcipampoolcidr" "example" {
  ipam_pool_id = aws_ec2_vpcipampool.example.id
  cidr         = "172.20.0.0/16"
}
resource "aws_ec2_vpcipampool" "example" {
  address_family = "ipv4"
  ipam_scope_id  = aws_ec2_vpcipam.example.private_default_scope_id
  locale         = data.aws_getregion.current.region
}
resource "aws_ec2_vpcipam" "example" {
  operating_regions {
    region_name = data.aws_getregion.current.region
  }
}
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 com.pulumi.aws.ec2.VpcIpamPoolCidrAllocation;
import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocationArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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(GetRegionArgs.builder()
            .build());

        var exampleVpcIpam = new VpcIpam("exampleVpcIpam", VpcIpamArgs.builder()
            .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                .regionName(current.region())
                .build())
            .build());

        var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
            .addressFamily("ipv4")
            .ipamScopeId(exampleVpcIpam.privateDefaultScopeId())
            .locale(current.region())
            .build());

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

        var example = new VpcIpamPoolCidrAllocation("example", VpcIpamPoolCidrAllocationArgs.builder()
            .ipamPoolId(exampleVpcIpamPool.id())
            .netmaskLength(28)
            .disallowedCidrs("172.20.0.0/28")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleVpcIpamPoolCidr)
                .build());

    }
}
resources:
  example:
    type: aws:ec2:VpcIpamPoolCidrAllocation
    properties:
      ipamPoolId: ${exampleVpcIpamPool.id}
      netmaskLength: 28
      disallowedCidrs:
        - 172.20.0.0/28
    options:
      dependsOn:
        - ${exampleVpcIpamPoolCidr}
  exampleVpcIpamPoolCidr:
    type: aws:ec2:VpcIpamPoolCidr
    name: example
    properties:
      ipamPoolId: ${exampleVpcIpamPool.id}
      cidr: 172.20.0.0/16
  exampleVpcIpamPool:
    type: aws:ec2:VpcIpamPool
    name: example
    properties:
      addressFamily: ipv4
      ipamScopeId: ${exampleVpcIpam.privateDefaultScopeId}
      locale: ${current.region}
  exampleVpcIpam:
    type: aws:ec2:VpcIpam
    name: example
    properties:
      operatingRegions:
        - regionName: ${current.region}
variables:
  current:
    fn::invoke:
      function: aws:getRegion
      arguments: {}

Import

Using pulumi import, import IPAM allocations using the allocation id and pool id, separated by _. For example:

$ pulumi import aws:ec2/vpcIpamPoolCidrAllocation:VpcIpamPoolCidrAllocation example ipam-pool-alloc-0dc6d196509c049ba8b549ff99f639736_ipam-pool-07cfb559e0921fcbe

Constructors

VpcIpamPoolCidrAllocation(String name, {VpcIpamPoolCidrAllocationArgs? args, CustomResourceOptions? options})
Creates a new VpcIpamPoolCidrAllocation. name The Pulumi resource name. args Arguments used to configure this VpcIpamPoolCidrAllocation. The set of arguments for VpcIpamPoolCidrAllocation. options Resource options controlling this resource's behavior.
VpcIpamPoolCidrAllocation.reference(String urn)
Creates a typed reference to an existing VpcIpamPoolCidrAllocation resource.

Properties

childResources → Set<Resource>
finalinherited
cidr ↔ Output<String>
The CIDR you want to assign to the pool.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
The description for the allocation.
latefinal
disallowedCidrs ↔ Output<List<String>?>
Exclude a particular CIDR range from being returned by the pool.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ipamPoolAllocationId ↔ Output<String>
latefinal
ipamPoolId ↔ Output<String>
The ID of the pool to which you want to assign a CIDR.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
netmaskLength ↔ Output<int>
The netmask length of the CIDR you would like to allocate to the IPAM pool. Valid Values: 0-128.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceId ↔ Output<String>
The ID of the resource.
latefinal
resourceOwner ↔ Output<String>
The owner of the resource.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
resourceType ↔ Output<String>
The type of the resource.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VpcIpamPoolCidrAllocationState? state, CustomResourceOptions? options}) → VpcIpamPoolCidrAllocation
Gets an existing VpcIpamPoolCidrAllocation resource's state with the given name and id.