Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. ec2
  6. getVpcIpams
Viewing docs for AWS v7.54.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.ec2.getVpcIpams

aws logo aws logo
Viewing docs for AWS v7.54.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Data source for managing VPC IPAMs.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getVpcIpams({
    ipamIds: ["ipam-abcd1234"],
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpc_ipams(ipam_ids=["ipam-abcd1234"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetVpcIpams(ctx, &ec2.GetVpcIpamsArgs{
			IpamIds: []string{
				"ipam-abcd1234",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetVpcIpams.Invoke(new()
    {
        IpamIds = new[]
        {
            "ipam-abcd1234",
        },
    });

});

    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.GetVpcIpamsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = Ec2Functions.getVpcIpams(GetVpcIpamsArgs.builder()
            .ipamIds("ipam-abcd1234")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        ipamIds:
          - ipam-abcd1234

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_vpc_ipams" "example" {
  ipam_ids = ["ipam-abcd1234"]
}

    Filter by tags

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getVpcIpams({
    filters: [{
        name: "tags.Some",
        values: ["Value"],
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpc_ipams(filters=[{
    "name": "tags.Some",
    "values": ["Value"],
}])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetVpcIpams(ctx, &ec2.GetVpcIpamsArgs{
			Filters: []ec2.GetVpcIpamsFilter{
				{
					Name: "tags.Some",
					Values: []string{
						"Value",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetVpcIpams.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetVpcIpamsFilterInputArgs
            {
                Name = "tags.Some",
                Values = new[]
                {
                    "Value",
                },
            },
        },
    });

});

    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.GetVpcIpamsArgs;
import com.pulumi.aws.ec2.inputs.GetVpcIpamsFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = Ec2Functions.getVpcIpams(GetVpcIpamsArgs.builder()
            .filters(GetVpcIpamsFilterArgs.builder()
                .name("tags.Some")
                .values("Value")
                .build())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        filters:
          - name: tags.Some
            values:
              - Value

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_vpc_ipams" "example" {
  filters {
    name   = "tags.Some"
    values = ["Value"]
  }
}

    Filter by tier

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getVpcIpams({
    filters: [{
        name: "tier",
        values: ["free"],
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpc_ipams(filters=[{
    "name": "tier",
    "values": ["free"],
}])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.GetVpcIpams(ctx, &ec2.GetVpcIpamsArgs{
			Filters: []ec2.GetVpcIpamsFilter{
				{
					Name: "tier",
					Values: []string{
						"free",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetVpcIpams.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetVpcIpamsFilterInputArgs
            {
                Name = "tier",
                Values = new[]
                {
                    "free",
                },
            },
        },
    });

});

    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.GetVpcIpamsArgs;
import com.pulumi.aws.ec2.inputs.GetVpcIpamsFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = Ec2Functions.getVpcIpams(GetVpcIpamsArgs.builder()
            .filters(GetVpcIpamsFilterArgs.builder()
                .name("tier")
                .values("free")
                .build())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        filters:
          - name: tier
            values:
              - free

    terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_vpc_ipams" "example" {
  filters {
    name   = "tier"
    values = ["free"]
  }
}

    Using getVpcIpams

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVpcIpams(args: GetVpcIpamsArgs, opts?: InvokeOptions): Promise<GetVpcIpamsResult>
function getVpcIpamsOutput(args: GetVpcIpamsOutputArgs, opts?: InvokeOutputOptions): Output<GetVpcIpamsResult>
    def get_vpc_ipams(filters: Optional[Sequence[GetVpcIpamsFilter]] = None,
                  ipam_ids: Optional[Sequence[str]] = None,
                  region: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVpcIpamsResult
def get_vpc_ipams_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetVpcIpamsFilterArgs]]]] = None,
                  ipam_ids: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                  region: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetVpcIpamsResult]
    func GetVpcIpams(ctx *Context, args *GetVpcIpamsArgs, opts ...InvokeOption) (*GetVpcIpamsResult, error)
func GetVpcIpamsOutput(ctx *Context, args *GetVpcIpamsOutputArgs, opts ...InvokeOption) GetVpcIpamsResultOutput

    > Note: This function is named GetVpcIpams in the Go SDK.

    public static class GetVpcIpams 
{
    public static Task<GetVpcIpamsResult> InvokeAsync(GetVpcIpamsArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcIpamsResult> Invoke(GetVpcIpamsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcIpamsResult> Invoke(GetVpcIpamsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetVpcIpamsResult> getVpcIpams(GetVpcIpamsArgs args, InvokeOptions options)
public static Output<GetVpcIpamsResult> getVpcIpams(GetVpcIpamsArgs args, InvokeOptions options)
public static Output<GetVpcIpamsResult> getVpcIpams(GetVpcIpamsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:ec2/getVpcIpams:getVpcIpams
  arguments:
    # arguments dictionary
    data "aws_ec2_get_vpc_ipams" "name" {
    # arguments
}

    The following arguments are supported:

    Filters List<GetVpcIpamsFilter>
    Custom filter block as described below.
    IpamIds List<string>
    IDs of the IPAM resources to query for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Filters []GetVpcIpamsFilter
    Custom filter block as described below.
    IpamIds []string
    IDs of the IPAM resources to query for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    filters list(object)
    Custom filter block as described below.
    ipam_ids list(string)
    IDs of the IPAM resources to query for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    filters List<GetVpcIpamsFilter>
    Custom filter block as described below.
    ipamIds List<String>
    IDs of the IPAM resources to query for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    filters GetVpcIpamsFilter[]
    Custom filter block as described below.
    ipamIds string[]
    IDs of the IPAM resources to query for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    filters Sequence[GetVpcIpamsFilter]
    Custom filter block as described below.
    ipam_ids Sequence[str]
    IDs of the IPAM resources to query for.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    filters List<Property Map>
    Custom filter block as described below.
    ipamIds List<String>
    IDs of the IPAM resources to query for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getVpcIpams Result

    The following output properties are available:

    Ipams List<GetVpcIpamsIpam>
    List of IPAM resources matching the provided arguments.
    Region string
    Filters List<GetVpcIpamsFilter>
    IpamIds List<string>
    Ipams []GetVpcIpamsIpam
    List of IPAM resources matching the provided arguments.
    Region string
    Filters []GetVpcIpamsFilter
    IpamIds []string
    ipams list(object)
    List of IPAM resources matching the provided arguments.
    region string
    filters list(object)
    ipam_ids list(string)
    ipams List<GetVpcIpamsIpam>
    List of IPAM resources matching the provided arguments.
    region String
    filters List<GetVpcIpamsFilter>
    ipamIds List<String>
    ipams GetVpcIpamsIpam[]
    List of IPAM resources matching the provided arguments.
    region string
    filters GetVpcIpamsFilter[]
    ipamIds string[]
    ipams Sequence[GetVpcIpamsIpam]
    List of IPAM resources matching the provided arguments.
    region str
    filters Sequence[GetVpcIpamsFilter]
    ipam_ids Sequence[str]
    ipams List<Property Map>
    List of IPAM resources matching the provided arguments.
    region String
    filters List<Property Map>
    ipamIds List<String>

    Supporting Types

    GetVpcIpamsFilter

    Name string
    Name of the field to filter by, as defined by the underlying AWS API.
    Values List<string>
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    Name string
    Name of the field to filter by, as defined by the underlying AWS API.
    Values []string
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    name string
    Name of the field to filter by, as defined by the underlying AWS API.
    values list(string)
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    name String
    Name of the field to filter by, as defined by the underlying AWS API.
    values List<String>
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    name string
    Name of the field to filter by, as defined by the underlying AWS API.
    values string[]
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    name str
    Name of the field to filter by, as defined by the underlying AWS API.
    values Sequence[str]
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.
    name String
    Name of the field to filter by, as defined by the underlying AWS API.
    values List<String>
    Set of values that are accepted for the given field. An IPAM resource will be selected if any one of the given values matches.

    GetVpcIpamsIpam

    Arn string
    ARN of the IPAM.
    DefaultResourceDiscoveryAssociationId string
    Default resource discovery association ID.
    DefaultResourceDiscoveryId string
    Default resource discovery ID.
    Description string
    Description for the IPAM.
    EnablePrivateGua bool
    If private GUA is enabled.
    Id string
    ID of the IPAM resource.
    IpamRegion string
    Region that the IPAM exists in.
    MeteredAccount string
    AWS account that is charged for active IP addresses managed in IPAM.
    OperatingRegions List<GetVpcIpamsIpamOperatingRegion>
    Regions that the IPAM is configured to operate in. See below.
    OwnerId string
    ID of the account that owns this IPAM.
    PrivateDefaultScopeId string
    ID of the default private scope.
    PublicDefaultScopeId string
    ID of the default public scope.
    ResourceDiscoveryAssociationCount int
    Number of resource discovery associations.
    ScopeCount int
    Number of scopes on this IPAM.
    State string
    Current state of the IPAM.
    StateMessage string
    State message of the IPAM.
    Tier string
    IPAM Tier.
    Arn string
    ARN of the IPAM.
    DefaultResourceDiscoveryAssociationId string
    Default resource discovery association ID.
    DefaultResourceDiscoveryId string
    Default resource discovery ID.
    Description string
    Description for the IPAM.
    EnablePrivateGua bool
    If private GUA is enabled.
    Id string
    ID of the IPAM resource.
    IpamRegion string
    Region that the IPAM exists in.
    MeteredAccount string
    AWS account that is charged for active IP addresses managed in IPAM.
    OperatingRegions []GetVpcIpamsIpamOperatingRegion
    Regions that the IPAM is configured to operate in. See below.
    OwnerId string
    ID of the account that owns this IPAM.
    PrivateDefaultScopeId string
    ID of the default private scope.
    PublicDefaultScopeId string
    ID of the default public scope.
    ResourceDiscoveryAssociationCount int
    Number of resource discovery associations.
    ScopeCount int
    Number of scopes on this IPAM.
    State string
    Current state of the IPAM.
    StateMessage string
    State message of the IPAM.
    Tier string
    IPAM Tier.
    arn string
    ARN of the IPAM.
    default_resource_discovery_association_id string
    Default resource discovery association ID.
    default_resource_discovery_id string
    Default resource discovery ID.
    description string
    Description for the IPAM.
    enable_private_gua bool
    If private GUA is enabled.
    id string
    ID of the IPAM resource.
    ipam_region string
    Region that the IPAM exists in.
    metered_account string
    AWS account that is charged for active IP addresses managed in IPAM.
    operating_regions list(object)
    Regions that the IPAM is configured to operate in. See below.
    owner_id string
    ID of the account that owns this IPAM.
    private_default_scope_id string
    ID of the default private scope.
    public_default_scope_id string
    ID of the default public scope.
    resource_discovery_association_count number
    Number of resource discovery associations.
    scope_count number
    Number of scopes on this IPAM.
    state string
    Current state of the IPAM.
    state_message string
    State message of the IPAM.
    tier string
    IPAM Tier.
    arn String
    ARN of the IPAM.
    defaultResourceDiscoveryAssociationId String
    Default resource discovery association ID.
    defaultResourceDiscoveryId String
    Default resource discovery ID.
    description String
    Description for the IPAM.
    enablePrivateGua Boolean
    If private GUA is enabled.
    id String
    ID of the IPAM resource.
    ipamRegion String
    Region that the IPAM exists in.
    meteredAccount String
    AWS account that is charged for active IP addresses managed in IPAM.
    operatingRegions List<GetVpcIpamsIpamOperatingRegion>
    Regions that the IPAM is configured to operate in. See below.
    ownerId String
    ID of the account that owns this IPAM.
    privateDefaultScopeId String
    ID of the default private scope.
    publicDefaultScopeId String
    ID of the default public scope.
    resourceDiscoveryAssociationCount Integer
    Number of resource discovery associations.
    scopeCount Integer
    Number of scopes on this IPAM.
    state String
    Current state of the IPAM.
    stateMessage String
    State message of the IPAM.
    tier String
    IPAM Tier.
    arn string
    ARN of the IPAM.
    defaultResourceDiscoveryAssociationId string
    Default resource discovery association ID.
    defaultResourceDiscoveryId string
    Default resource discovery ID.
    description string
    Description for the IPAM.
    enablePrivateGua boolean
    If private GUA is enabled.
    id string
    ID of the IPAM resource.
    ipamRegion string
    Region that the IPAM exists in.
    meteredAccount string
    AWS account that is charged for active IP addresses managed in IPAM.
    operatingRegions GetVpcIpamsIpamOperatingRegion[]
    Regions that the IPAM is configured to operate in. See below.
    ownerId string
    ID of the account that owns this IPAM.
    privateDefaultScopeId string
    ID of the default private scope.
    publicDefaultScopeId string
    ID of the default public scope.
    resourceDiscoveryAssociationCount number
    Number of resource discovery associations.
    scopeCount number
    Number of scopes on this IPAM.
    state string
    Current state of the IPAM.
    stateMessage string
    State message of the IPAM.
    tier string
    IPAM Tier.
    arn str
    ARN of the IPAM.
    default_resource_discovery_association_id str
    Default resource discovery association ID.
    default_resource_discovery_id str
    Default resource discovery ID.
    description str
    Description for the IPAM.
    enable_private_gua bool
    If private GUA is enabled.
    id str
    ID of the IPAM resource.
    ipam_region str
    Region that the IPAM exists in.
    metered_account str
    AWS account that is charged for active IP addresses managed in IPAM.
    operating_regions Sequence[GetVpcIpamsIpamOperatingRegion]
    Regions that the IPAM is configured to operate in. See below.
    owner_id str
    ID of the account that owns this IPAM.
    private_default_scope_id str
    ID of the default private scope.
    public_default_scope_id str
    ID of the default public scope.
    resource_discovery_association_count int
    Number of resource discovery associations.
    scope_count int
    Number of scopes on this IPAM.
    state str
    Current state of the IPAM.
    state_message str
    State message of the IPAM.
    tier str
    IPAM Tier.
    arn String
    ARN of the IPAM.
    defaultResourceDiscoveryAssociationId String
    Default resource discovery association ID.
    defaultResourceDiscoveryId String
    Default resource discovery ID.
    description String
    Description for the IPAM.
    enablePrivateGua Boolean
    If private GUA is enabled.
    id String
    ID of the IPAM resource.
    ipamRegion String
    Region that the IPAM exists in.
    meteredAccount String
    AWS account that is charged for active IP addresses managed in IPAM.
    operatingRegions List<Property Map>
    Regions that the IPAM is configured to operate in. See below.
    ownerId String
    ID of the account that owns this IPAM.
    privateDefaultScopeId String
    ID of the default private scope.
    publicDefaultScopeId String
    ID of the default public scope.
    resourceDiscoveryAssociationCount Number
    Number of resource discovery associations.
    scopeCount Number
    Number of scopes on this IPAM.
    state String
    Current state of the IPAM.
    stateMessage String
    State message of the IPAM.
    tier String
    IPAM Tier.

    GetVpcIpamsIpamOperatingRegion

    RegionName string
    Name of the Region.
    RegionName string
    Name of the Region.
    region_name string
    Name of the Region.
    regionName String
    Name of the Region.
    regionName string
    Name of the Region.
    region_name str
    Name of the Region.
    regionName String
    Name of the Region.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.54.0
    published on Friday, Nov 6, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial