VpcIpam

class VpcIpam : KotlinCustomResource

Provides an IPAM resource.

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const current = aws.getRegion({});
const main = new aws.ec2.VpcIpam("main", {
description: "My IPAM",
operatingRegions: [{
regionName: current.then(current => current.name),
}],
tags: {
Test: "Main",
},
});
import pulumi
import pulumi_aws as aws
current = aws.get_region()
main = aws.ec2.VpcIpam("main",
description="My IPAM",
operating_regions=[{
"region_name": current.name,
}],
tags={
"Test": "Main",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var current = Aws.GetRegion.Invoke();
var main = new Aws.Ec2.VpcIpam("main", new()
{
Description = "My IPAM",
OperatingRegions = new[]
{
new Aws.Ec2.Inputs.VpcIpamOperatingRegionArgs
{
RegionName = current.Apply(getRegionResult => getRegionResult.Name),
},
},
Tags =
{
{ "Test", "Main" },
},
});
});
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, &aws.GetRegionArgs{}, nil)
if err != nil {
return err
}
_, err = ec2.NewVpcIpam(ctx, "main", &ec2.VpcIpamArgs{
Description: pulumi.String("My IPAM"),
OperatingRegions: ec2.VpcIpamOperatingRegionArray{
&ec2.VpcIpamOperatingRegionArgs{
RegionName: pulumi.String(current.Name),
},
},
Tags: pulumi.StringMap{
"Test": pulumi.String("Main"),
},
})
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 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 main = new VpcIpam("main", VpcIpamArgs.builder()
.description("My IPAM")
.operatingRegions(VpcIpamOperatingRegionArgs.builder()
.regionName(current.applyValue(getRegionResult -> getRegionResult.name()))
.build())
.tags(Map.of("Test", "Main"))
.build());
}
}
resources:
main:
type: aws:ec2:VpcIpam
properties:
description: My IPAM
operatingRegions:
- regionName: ${current.name}
tags:
Test: Main
variables:
current:
fn::invoke:
function: aws:getRegion
arguments: {}

Shared with multiple operating_regions:

Import

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

$ pulumi import aws:ec2/vpcIpam:VpcIpam example ipam-0178368ad2146a492

Properties

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name (ARN) of IPAM

Link copied to clipboard
val cascade: Output<Boolean>?

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.

Link copied to clipboard

The IPAM's default resource discovery association ID.

Link copied to clipboard

The IPAM's default resource discovery ID.

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

A description for the IPAM.

Link copied to clipboard

Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

Determines which locales can be chosen when you create pools. 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. You specify a region using the region_name parameter. You must set your provider block region as an operating_region.

Link copied to clipboard

The ID of the IPAM's private scope. A scope is a top-level container in IPAM. Each scope represents an IP-independent network. Scopes enable you to represent networks where you have overlapping IP space. When you create an IPAM, IPAM automatically creates two scopes: public and private. The private scope is intended for private IP space. The public scope is intended for all internet-routable IP space.

Link copied to clipboard

The ID of the IPAM's public scope. A scope is a top-level container in IPAM. Each scope represents an IP-independent network. Scopes enable you to represent networks where you have overlapping IP space. When you create an IPAM, IPAM automatically creates two scopes: public and private. The private scope is intended for private IP space. The public scope is intended for all internet-routable IP space.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val scopeCount: Output<Int>

The number of scopes in the IPAM.

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

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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val tier: Output<String>?

specifies the IPAM tier. Valid options include free and advanced. Default is advanced.

Link copied to clipboard
val urn: Output<String>