pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getIpamPreviewNextCidr

getIpamPreviewNextCidr

suspend fun getIpamPreviewNextCidr(argument: GetIpamPreviewNextCidrPlainArgs): GetIpamPreviewNextCidrResult

Previews a CIDR from an IPAM address pool. Only works for private IPv4.

NOTE: This functionality is also encapsulated in a resource sharing the same name. The data source can be used when you need to use the cidr in a calculation of the same Root module, count for example. However, once a cidr range has been allocated that was previewed, the next refresh will find a new cidr and may force new resources downstream. Make sure to use ignore_changes if this is undesirable.

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.ec2.getIpamPreviewNextCidr({
    ipamPoolId: testAwsVpcIpamPool.id,
    netmaskLength: 28,
});
const testVpcIpamPoolCidrAllocation = new aws.ec2.VpcIpamPoolCidrAllocation("test", {
    ipamPoolId: testAwsVpcIpamPool.id,
    cidr: test.then(test => test.cidr),
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
test = aws.ec2.get_ipam_preview_next_cidr(ipam_pool_id=test_aws_vpc_ipam_pool["id"],
    netmask_length=28)
test_vpc_ipam_pool_cidr_allocation = aws.ec2.VpcIpamPoolCidrAllocation("test",
    ipam_pool_id=test_aws_vpc_ipam_pool["id"],
    cidr=test.cidr)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var test = Aws.Ec2.GetIpamPreviewNextCidr.Invoke(new()
    {
        IpamPoolId = testAwsVpcIpamPool.Id,
        NetmaskLength = 28,
    });
    var testVpcIpamPoolCidrAllocation = new Aws.Ec2.VpcIpamPoolCidrAllocation("test", new()
    {
        IpamPoolId = testAwsVpcIpamPool.Id,
        Cidr = test.Apply(getIpamPreviewNextCidrResult => getIpamPreviewNextCidrResult.Cidr),
    });
});
Content copied to clipboard
package main
import (
	"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 {
		test, err := ec2.GetIpamPreviewNextCidr(ctx, &ec2.GetIpamPreviewNextCidrArgs{
			IpamPoolId:    testAwsVpcIpamPool.Id,
			NetmaskLength: pulumi.IntRef(28),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ec2.NewVpcIpamPoolCidrAllocation(ctx, "test", &ec2.VpcIpamPoolCidrAllocationArgs{
			IpamPoolId: pulumi.Any(testAwsVpcIpamPool.Id),
			Cidr:       pulumi.String(test.Cidr),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetIpamPreviewNextCidrArgs;
import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocation;
import com.pulumi.aws.ec2.VpcIpamPoolCidrAllocationArgs;
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 test = Ec2Functions.getIpamPreviewNextCidr(GetIpamPreviewNextCidrArgs.builder()
            .ipamPoolId(testAwsVpcIpamPool.id())
            .netmaskLength(28)
            .build());
        var testVpcIpamPoolCidrAllocation = new VpcIpamPoolCidrAllocation("testVpcIpamPoolCidrAllocation", VpcIpamPoolCidrAllocationArgs.builder()
            .ipamPoolId(testAwsVpcIpamPool.id())
            .cidr(test.cidr())
            .build());
    }
}
Content copied to clipboard
resources:
  testVpcIpamPoolCidrAllocation:
    type: aws:ec2:VpcIpamPoolCidrAllocation
    name: test
    properties:
      ipamPoolId: ${testAwsVpcIpamPool.id}
      cidr: ${test.cidr}
variables:
  test:
    fn::invoke:
      function: aws:ec2:getIpamPreviewNextCidr
      arguments:
        ipamPoolId: ${testAwsVpcIpamPool.id}
        netmaskLength: 28
Content copied to clipboard

Return

A collection of values returned by getIpamPreviewNextCidr.

Parameters

argument

A collection of arguments for invoking getIpamPreviewNextCidr.

suspend fun getIpamPreviewNextCidr(disallowedCidrs: List<String>? = null, ipamPoolId: String, netmaskLength: Int? = null): GetIpamPreviewNextCidrResult

Return

A collection of values returned by getIpamPreviewNextCidr.

Parameters

disallowedCidrs

Exclude a particular CIDR range from being returned by the pool.

ipamPoolId

ID of the pool to which you want to assign a CIDR.

netmaskLength

Netmask length of the CIDR you would like to preview from the IPAM pool.

See also

.

suspend fun getIpamPreviewNextCidr(argument: suspend GetIpamPreviewNextCidrPlainArgsBuilder.() -> Unit): GetIpamPreviewNextCidrResult

Return

A collection of values returned by getIpamPreviewNextCidr.

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetIpamPreviewNextCidrPlainArgs.

See also

.