pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getVpcIpams

getVpcIpams

suspend fun getVpcIpams(argument: GetVpcIpamsPlainArgs): GetVpcIpamsResult

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"],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ec2.get_vpc_ipams(ipam_ids=["ipam-abcd1234"])
Content copied to clipboard
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",
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        ipamIds:
          - ipam-abcd1234
Content copied to clipboard

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"],
    }],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ec2.get_vpc_ipams(filters=[{
    "name": "tags.Some",
    "values": ["Value"],
}])
Content copied to clipboard
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",
                },
            },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        filters:
          - name: tags.Some
            values:
              - Value
Content copied to clipboard

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"],
    }],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ec2.get_vpc_ipams(filters=[{
    "name": "tier",
    "values": ["free"],
}])
Content copied to clipboard
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",
                },
            },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpcIpams
      arguments:
        filters:
          - name: tier
            values:
              - free
Content copied to clipboard

Return

A collection of values returned by getVpcIpams.

Parameters

argument

A collection of arguments for invoking getVpcIpams.

suspend fun getVpcIpams(filters: List<GetVpcIpamsFilter>? = null, ipamIds: List<String>? = null): GetVpcIpamsResult

Return

A collection of values returned by getVpcIpams.

Parameters

filters

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

IDs of the IPAM resources to query for.

See also

.

suspend fun getVpcIpams(argument: suspend GetVpcIpamsPlainArgsBuilder.() -> Unit): GetVpcIpamsResult

Return

A collection of values returned by getVpcIpams.

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetVpcIpamsPlainArgs.

See also

.