VpcIpamPoolArgs

data class VpcIpamPoolArgs(val addressFamily: Output<String>? = null, val allocationDefaultNetmaskLength: Output<Int>? = null, val allocationMaxNetmaskLength: Output<Int>? = null, val allocationMinNetmaskLength: Output<Int>? = null, val allocationResourceTags: Output<Map<String, String>>? = null, val autoImport: Output<Boolean>? = null, val awsService: Output<String>? = null, val description: Output<String>? = null, val ipamScopeId: Output<String>? = null, val locale: Output<String>? = null, val publicIpSource: Output<String>? = null, val publiclyAdvertisable: Output<Boolean>? = null, val sourceIpamPoolId: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<VpcIpamPoolArgs>

Provides an IP address pool resource for IPAM.

Example Usage

Basic usage:

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 exampleVpcIpam = new VpcIpam("exampleVpcIpam", VpcIpamArgs.builder()
.operatingRegions(VpcIpamOperatingRegionArgs.builder()
.regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
.build())
.build());
var exampleVpcIpamPool = new VpcIpamPool("exampleVpcIpamPool", VpcIpamPoolArgs.builder()
.addressFamily("ipv4")
.ipamScopeId(exampleVpcIpam.privateDefaultScopeId())
.locale(current.applyValue(getRegionResult -> getRegionResult.name()))
.build());
}
}

Import

IPAMs can be imported using the ipam pool id, e.g.

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

Constructors

Link copied to clipboard
constructor(addressFamily: Output<String>? = null, allocationDefaultNetmaskLength: Output<Int>? = null, allocationMaxNetmaskLength: Output<Int>? = null, allocationMinNetmaskLength: Output<Int>? = null, allocationResourceTags: Output<Map<String, String>>? = null, autoImport: Output<Boolean>? = null, awsService: Output<String>? = null, description: Output<String>? = null, ipamScopeId: Output<String>? = null, locale: Output<String>? = null, publicIpSource: Output<String>? = null, publiclyAdvertisable: Output<Boolean>? = null, sourceIpamPoolId: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val addressFamily: Output<String>? = null

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

Link copied to clipboard
val allocationDefaultNetmaskLength: Output<Int>? = null

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).

Link copied to clipboard
val allocationMaxNetmaskLength: Output<Int>? = null

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

Link copied to clipboard
val allocationMinNetmaskLength: Output<Int>? = null

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

Link copied to clipboard
val allocationResourceTags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val autoImport: Output<Boolean>? = null

If you include this argument, IPAM automatically imports any VPCs you have in your scope that fall within the CIDR range in the pool.

Link copied to clipboard
val awsService: Output<String>? = null

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

Link copied to clipboard
val description: Output<String>? = null

A description for the IPAM pool.

Link copied to clipboard
val ipamScopeId: Output<String>? = null

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

Link copied to clipboard
val locale: Output<String>? = null

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.

Link copied to clipboard
val publicIpSource: Output<String>? = null

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.

Link copied to clipboard
val publiclyAdvertisable: Output<Boolean>? = null

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".

Link copied to clipboard
val sourceIpamPoolId: Output<String>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): VpcIpamPoolArgs