Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. getVpcIpams
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.getVpcIpams

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
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/v6/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.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 example = Ec2Functions.getVpcIpams(GetVpcIpamsArgs.builder()
            .ipamIds("ipam-abcd1234")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        ipamIds:
          - 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/v6/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 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 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

    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/v6/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 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 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

    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?: InvokeOptions): Output<GetVpcIpamsResult>
    def get_vpc_ipams(filters: Optional[Sequence[GetVpcIpamsFilter]] = None,
                  ipam_ids: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVpcIpamsResult
def get_vpc_ipams_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpcIpamsFilterArgs]]]] = None,
                  ipam_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = 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 CompletableFuture<GetVpcIpamsResult> getVpcIpams(GetVpcIpamsArgs args, InvokeOptions options)
public static Output<GetVpcIpamsResult> getVpcIpams(GetVpcIpamsArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:ec2/getVpcIpams:getVpcIpams
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetVpcIpamsFilter>

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    IpamIds List<string>
    IDs of the IPAM resources to query for.
    Filters []GetVpcIpamsFilter

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    IpamIds []string
    IDs of the IPAM resources to query for.
    filters List<GetVpcIpamsFilter>

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    ipamIds List<String>
    IDs of the IPAM resources to query for.
    filters GetVpcIpamsFilter[]

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    ipamIds string[]
    IDs of the IPAM resources to query for.
    filters Sequence[GetVpcIpamsFilter]

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    ipam_ids Sequence[str]
    IDs of the IPAM resources to query for.
    filters List<Property Map>

    Custom filter block as described below.

    More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

    ipamIds List<String>
    IDs of the IPAM resources to query for.

    getVpcIpams Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ipams List<GetVpcIpamsIpam>
    List of IPAM resources matching the provided arguments.
    Filters List<GetVpcIpamsFilter>
    IpamIds List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Ipams []GetVpcIpamsIpam
    List of IPAM resources matching the provided arguments.
    Filters []GetVpcIpamsFilter
    IpamIds []string
    id String
    The provider-assigned unique ID for this managed resource.
    ipams List<GetVpcIpamsIpam>
    List of IPAM resources matching the provided arguments.
    filters List<GetVpcIpamsFilter>
    ipamIds List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    ipams GetVpcIpamsIpam[]
    List of IPAM resources matching the provided arguments.
    filters GetVpcIpamsFilter[]
    ipamIds string[]
    id str
    The provider-assigned unique ID for this managed resource.
    ipams Sequence[GetVpcIpamsIpam]
    List of IPAM resources matching the provided arguments.
    filters Sequence[GetVpcIpamsFilter]
    ipam_ids Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    ipams List<Property Map>
    List of IPAM resources matching the provided arguments.
    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 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
    The default resource discovery association ID.
    DefaultResourceDiscoveryId string
    The 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.
    OperatingRegions List<GetVpcIpamsIpamOperatingRegion>
    Regions that the IPAM is configured to operate in.
    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
    The default resource discovery association ID.
    DefaultResourceDiscoveryId string
    The 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.
    OperatingRegions []GetVpcIpamsIpamOperatingRegion
    Regions that the IPAM is configured to operate in.
    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
    The default resource discovery association ID.
    defaultResourceDiscoveryId String
    The 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.
    operatingRegions List<GetVpcIpamsIpamOperatingRegion>
    Regions that the IPAM is configured to operate in.
    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
    The default resource discovery association ID.
    defaultResourceDiscoveryId string
    The 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.
    operatingRegions GetVpcIpamsIpamOperatingRegion[]
    Regions that the IPAM is configured to operate in.
    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
    The default resource discovery association ID.
    default_resource_discovery_id str
    The 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.
    operating_regions Sequence[GetVpcIpamsIpamOperatingRegion]
    Regions that the IPAM is configured to operate in.
    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
    The default resource discovery association ID.
    defaultResourceDiscoveryId String
    The 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.
    operatingRegions List<Property Map>
    Regions that the IPAM is configured to operate in.
    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
    RegionName string
    regionName String
    regionName string
    regionName String

    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 v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws