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:

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 testIpamPreviewNextCidr = Ec2Functions.getIpamPreviewNextCidr(GetIpamPreviewNextCidrArgs.builder()
            .ipamPoolId(aws_vpc_ipam_pool.test().id())
            .netmaskLength(28)
            .build());
        var testVpcIpamPoolCidrAllocation = new VpcIpamPoolCidrAllocation("testVpcIpamPoolCidrAllocation", VpcIpamPoolCidrAllocationArgs.builder()
            .ipamPoolId(aws_vpc_ipam_pool.test().id())
            .cidr(testIpamPreviewNextCidr.applyValue(getIpamPreviewNextCidrResult -> getIpamPreviewNextCidrResult.cidr()))
            .build());
    }
}
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

.