getVpcIpams function

Future<GetVpcIpamsResult> getVpcIpams(
  1. GetVpcIpamsArgs args, {
  2. InvokeOptions? options,
})

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"])
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 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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getvpcipams" "example" {
  ipam_ids = ["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

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"],
}])
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 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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getvpcipams" "example" {
  filters {
    name   = "tags.Some"
    values = ["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

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"],
}])
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 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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getvpcipams" "example" {
  filters {
    name   = "tier"
    values = ["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

args Arguments passed to this invoke. Arguments for getVpcIpams. options Invoke options controlling this call.

Implementation

Future<GetVpcIpamsResult> getVpcIpams(
  GetVpcIpamsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ec2/getVpcIpams:getVpcIpams',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetVpcIpamsResult.fromMap(result);
}