getVpcIpam

AWS v6.83.1 (6.x), Mar 9 26

Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v6.83.1 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const example = aws.ec2.getVpcIpam({
    id: "ipam-abcd1234",
});

import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpc_ipam(id="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.LookupVpcIpam(ctx, &ec2.LookupVpcIpamArgs{
			Id: "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.GetVpcIpam.Invoke(new()
    {
        Id = "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.GetVpcIpamArgs;
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.getVpcIpam(GetVpcIpamArgs.builder()
            .id("ipam-abcd1234")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpam
      arguments:
        id: ipam-abcd1234

Using getVpcIpam

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 getVpcIpam(args: GetVpcIpamArgs, opts?: InvokeOptions): Promise<GetVpcIpamResult>
function getVpcIpamOutput(args: GetVpcIpamOutputArgs, opts?: InvokeOptions): Output<GetVpcIpamResult>

def get_vpc_ipam(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVpcIpamResult
def get_vpc_ipam_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetVpcIpamResult]

func LookupVpcIpam(ctx *Context, args *LookupVpcIpamArgs, opts ...InvokeOption) (*LookupVpcIpamResult, error)
func LookupVpcIpamOutput(ctx *Context, args *LookupVpcIpamOutputArgs, opts ...InvokeOption) LookupVpcIpamResultOutput

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

public static class GetVpcIpam 
{
    public static Task<GetVpcIpamResult> InvokeAsync(GetVpcIpamArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcIpamResult> Invoke(GetVpcIpamInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpcIpamResult> getVpcIpam(GetVpcIpamArgs args, InvokeOptions options)
public static Output<GetVpcIpamResult> getVpcIpam(GetVpcIpamArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: ID of the IPAM.

Id string: ID of the IPAM.

id String: ID of the IPAM.

id string: ID of the IPAM.

id str: ID of the IPAM.

id String: ID of the IPAM.

getVpcIpam Result

The following output properties are available:

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<GetVpcIpamOperatingRegion>: 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.
Tags Dictionary<string, string>: Tags of the IPAM resource.
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 []GetVpcIpamOperatingRegion: 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.
Tags map[string]string: Tags of the IPAM resource.
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<GetVpcIpamOperatingRegion>: 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.
tags Map<String,String>: Tags of the IPAM resource.
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 GetVpcIpamOperatingRegion[]: 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.
tags {[key: string]: string}: Tags of the IPAM resource.
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[GetVpcIpamOperatingRegion]: 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.
tags Mapping[str, str]: Tags of the IPAM resource.
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.
tags Map<String>: Tags of the IPAM resource.
tier String: IPAM Tier.