1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. VpcIpam
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.ec2.VpcIpam

Explore with Pulumi AI

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",
    },
});
Copy
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",
    })
Copy
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
	})
}
Copy
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" },
        },
    });

});
Copy
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(GetRegionArgs.builder()
            .build());

        var main = new VpcIpam("main", VpcIpamArgs.builder()
            .description("My IPAM")
            .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                .regionName(current.name())
                .build())
            .tags(Map.of("Test", "Main"))
            .build());

    }
}
Copy
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: {}
Copy

Shared with multiple operating_regions:

Create VpcIpam Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VpcIpam(name: string, args: VpcIpamArgs, opts?: CustomResourceOptions);
@overload
def VpcIpam(resource_name: str,
            args: VpcIpamArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def VpcIpam(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            operating_regions: Optional[Sequence[VpcIpamOperatingRegionArgs]] = None,
            cascade: Optional[bool] = None,
            description: Optional[str] = None,
            enable_private_gua: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tier: Optional[str] = None)
func NewVpcIpam(ctx *Context, name string, args VpcIpamArgs, opts ...ResourceOption) (*VpcIpam, error)
public VpcIpam(string name, VpcIpamArgs args, CustomResourceOptions? opts = null)
public VpcIpam(String name, VpcIpamArgs args)
public VpcIpam(String name, VpcIpamArgs args, CustomResourceOptions options)
type: aws:ec2:VpcIpam
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcIpamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcIpamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcIpamArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vpcIpamResource = new Aws.Ec2.VpcIpam("vpcIpamResource", new()
{
    OperatingRegions = new[]
    {
        new Aws.Ec2.Inputs.VpcIpamOperatingRegionArgs
        {
            RegionName = "string",
        },
    },
    Cascade = false,
    Description = "string",
    EnablePrivateGua = false,
    Tags = 
    {
        { "string", "string" },
    },
    Tier = "string",
});
Copy
example, err := ec2.NewVpcIpam(ctx, "vpcIpamResource", &ec2.VpcIpamArgs{
	OperatingRegions: ec2.VpcIpamOperatingRegionArray{
		&ec2.VpcIpamOperatingRegionArgs{
			RegionName: pulumi.String("string"),
		},
	},
	Cascade:          pulumi.Bool(false),
	Description:      pulumi.String("string"),
	EnablePrivateGua: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tier: pulumi.String("string"),
})
Copy
var vpcIpamResource = new VpcIpam("vpcIpamResource", VpcIpamArgs.builder()
    .operatingRegions(VpcIpamOperatingRegionArgs.builder()
        .regionName("string")
        .build())
    .cascade(false)
    .description("string")
    .enablePrivateGua(false)
    .tags(Map.of("string", "string"))
    .tier("string")
    .build());
Copy
vpc_ipam_resource = aws.ec2.VpcIpam("vpcIpamResource",
    operating_regions=[{
        "region_name": "string",
    }],
    cascade=False,
    description="string",
    enable_private_gua=False,
    tags={
        "string": "string",
    },
    tier="string")
Copy
const vpcIpamResource = new aws.ec2.VpcIpam("vpcIpamResource", {
    operatingRegions: [{
        regionName: "string",
    }],
    cascade: false,
    description: "string",
    enablePrivateGua: false,
    tags: {
        string: "string",
    },
    tier: "string",
});
Copy
type: aws:ec2:VpcIpam
properties:
    cascade: false
    description: string
    enablePrivateGua: false
    operatingRegions:
        - regionName: string
    tags:
        string: string
    tier: string
Copy

VpcIpam Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VpcIpam resource accepts the following input properties:

OperatingRegions This property is required. List<VpcIpamOperatingRegion>
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.
Cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
Description string
A description for the IPAM.
EnablePrivateGua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
Tags Dictionary<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.
Tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
OperatingRegions This property is required. []VpcIpamOperatingRegionArgs
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.
Cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
Description string
A description for the IPAM.
EnablePrivateGua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
Tags 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.
Tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
operatingRegions This property is required. List<VpcIpamOperatingRegion>
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.
cascade Boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
description String
A description for the IPAM.
enablePrivateGua Boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
tags 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.
tier String
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
operatingRegions This property is required. VpcIpamOperatingRegion[]
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.
cascade boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
description string
A description for the IPAM.
enablePrivateGua boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
tags {[key: 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.
tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
operating_regions This property is required. Sequence[VpcIpamOperatingRegionArgs]
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.
cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
description str
A description for the IPAM.
enable_private_gua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
tags Mapping[str, str]
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.
tier str
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
operatingRegions This property is required. List<Property Map>
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.
cascade Boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
description String
A description for the IPAM.
enablePrivateGua Boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
tags Map<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.
tier String
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpcIpam resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of IPAM
DefaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
DefaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
Id string
The provider-assigned unique ID for this managed resource.
PrivateDefaultScopeId string
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.
PublicDefaultScopeId string
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.
ScopeCount int
The number of scopes in the IPAM.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of IPAM
DefaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
DefaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
Id string
The provider-assigned unique ID for this managed resource.
PrivateDefaultScopeId string
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.
PublicDefaultScopeId string
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.
ScopeCount int
The number of scopes in the IPAM.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of IPAM
defaultResourceDiscoveryAssociationId String
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId String
The IPAM's default resource discovery ID.
id String
The provider-assigned unique ID for this managed resource.
privateDefaultScopeId String
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.
publicDefaultScopeId String
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.
scopeCount Integer
The number of scopes in the IPAM.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of IPAM
defaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
id string
The provider-assigned unique ID for this managed resource.
privateDefaultScopeId string
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.
publicDefaultScopeId string
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.
scopeCount number
The number of scopes in the IPAM.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of IPAM
default_resource_discovery_association_id str
The IPAM's default resource discovery association ID.
default_resource_discovery_id str
The IPAM's default resource discovery ID.
id str
The provider-assigned unique ID for this managed resource.
private_default_scope_id str
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.
public_default_scope_id str
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.
scope_count int
The number of scopes in the IPAM.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of IPAM
defaultResourceDiscoveryAssociationId String
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId String
The IPAM's default resource discovery ID.
id String
The provider-assigned unique ID for this managed resource.
privateDefaultScopeId String
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.
publicDefaultScopeId String
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.
scopeCount Number
The number of scopes in the IPAM.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing VpcIpam Resource

Get an existing VpcIpam resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcIpamState, opts?: CustomResourceOptions): VpcIpam
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cascade: Optional[bool] = None,
        default_resource_discovery_association_id: Optional[str] = None,
        default_resource_discovery_id: Optional[str] = None,
        description: Optional[str] = None,
        enable_private_gua: Optional[bool] = None,
        operating_regions: Optional[Sequence[VpcIpamOperatingRegionArgs]] = None,
        private_default_scope_id: Optional[str] = None,
        public_default_scope_id: Optional[str] = None,
        scope_count: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        tier: Optional[str] = None) -> VpcIpam
func GetVpcIpam(ctx *Context, name string, id IDInput, state *VpcIpamState, opts ...ResourceOption) (*VpcIpam, error)
public static VpcIpam Get(string name, Input<string> id, VpcIpamState? state, CustomResourceOptions? opts = null)
public static VpcIpam get(String name, Output<String> id, VpcIpamState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2:VpcIpam    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN) of IPAM
Cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
DefaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
DefaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
Description string
A description for the IPAM.
EnablePrivateGua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
OperatingRegions List<VpcIpamOperatingRegion>
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.
PrivateDefaultScopeId string
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.
PublicDefaultScopeId string
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.
ScopeCount int
The number of scopes in the IPAM.
Tags Dictionary<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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
Arn string
Amazon Resource Name (ARN) of IPAM
Cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
DefaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
DefaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
Description string
A description for the IPAM.
EnablePrivateGua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
OperatingRegions []VpcIpamOperatingRegionArgs
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.
PrivateDefaultScopeId string
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.
PublicDefaultScopeId string
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.
ScopeCount int
The number of scopes in the IPAM.
Tags 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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
arn String
Amazon Resource Name (ARN) of IPAM
cascade Boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
defaultResourceDiscoveryAssociationId String
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId String
The IPAM's default resource discovery ID.
description String
A description for the IPAM.
enablePrivateGua Boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
operatingRegions List<VpcIpamOperatingRegion>
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.
privateDefaultScopeId String
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.
publicDefaultScopeId String
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.
scopeCount Integer
The number of scopes in the IPAM.
tags 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.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tier String
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
arn string
Amazon Resource Name (ARN) of IPAM
cascade boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
defaultResourceDiscoveryAssociationId string
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId string
The IPAM's default resource discovery ID.
description string
A description for the IPAM.
enablePrivateGua boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
operatingRegions VpcIpamOperatingRegion[]
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.
privateDefaultScopeId string
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.
publicDefaultScopeId string
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.
scopeCount number
The number of scopes in the IPAM.
tags {[key: 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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tier string
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
arn str
Amazon Resource Name (ARN) of IPAM
cascade bool
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
default_resource_discovery_association_id str
The IPAM's default resource discovery association ID.
default_resource_discovery_id str
The IPAM's default resource discovery ID.
description str
A description for the IPAM.
enable_private_gua bool
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
operating_regions Sequence[VpcIpamOperatingRegionArgs]
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.
private_default_scope_id str
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.
public_default_scope_id str
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.
scope_count int
The number of scopes in the IPAM.
tags Mapping[str, str]
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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

tier str
specifies the IPAM tier. Valid options include free and advanced. Default is advanced.
arn String
Amazon Resource Name (ARN) of IPAM
cascade Boolean
Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes.
defaultResourceDiscoveryAssociationId String
The IPAM's default resource discovery association ID.
defaultResourceDiscoveryId String
The IPAM's default resource discovery ID.
description String
A description for the IPAM.
enablePrivateGua Boolean
Enable this option to use your own GUA ranges as private IPv6 addresses. Default: false.
operatingRegions List<Property Map>
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.
privateDefaultScopeId String
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.
publicDefaultScopeId String
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.
scopeCount Number
The number of scopes in the IPAM.
tags Map<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.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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

Supporting Types

VpcIpamOperatingRegion
, VpcIpamOperatingRegionArgs

RegionName This property is required. string
The name of the Region you want to add to the IPAM.
RegionName This property is required. string
The name of the Region you want to add to the IPAM.
regionName This property is required. String
The name of the Region you want to add to the IPAM.
regionName This property is required. string
The name of the Region you want to add to the IPAM.
region_name This property is required. str
The name of the Region you want to add to the IPAM.
regionName This property is required. String
The name of the Region you want to add to the IPAM.

Import

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

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.