getVpcs function
This resource can be useful for getting back a list of VPC Ids for a region.
The following example retrieves a list of VPC Ids with a custom tag of service set to a value of "production".
Example Usage
The following shows outputting all VPC Ids.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
export = async () => {
const foo = await aws.ec2.getVpcs({
tags: {
service: "production",
},
});
return {
foo: foo.ids,
};
}
import pulumi
import pulumi_aws as aws
foo = aws.ec2.get_vpcs(tags={
"service": "production",
})
pulumi.export("foo", foo.ids)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.Ec2.GetVpcs.Invoke(new()
{
Tags =
{
{ "service", "production" },
},
});
return new Dictionary<string, object?>
{
["foo"] = foo.Apply(getVpcsResult => getVpcsResult.Ids),
};
});
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 {
foo, err := ec2.GetVpcs(ctx, &ec2.GetVpcsArgs{
Tags: map[string]string{
"service": "production",
},
}, nil)
if err != nil {
return err
}
ctx.Export("foo", foo.Ids)
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ec2_getvpcs" "foo" {
tags = {
"service" = "production"
}
}
output "foo" {
value = data.aws_ec2_getvpcs.foo.ids
}
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.GetVpcsArgs;
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 foo = Ec2Functions.getVpcs(GetVpcsArgs.builder()
.tags(Map.of("service", "production"))
.build());
ctx.export("foo", foo.ids());
}
}
variables:
foo:
fn::invoke:
function: aws:ec2:getVpcs
arguments:
tags:
service: production
outputs:
foo: ${foo.ids}
An example use case would be interpolate the aws.ec2.getVpcs output into count of an aws.ec2.FlowLog resource.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
export = async () => {
const foo = await aws.ec2.getVpcs({});
const fooGetVpc = .map(__index => (await aws.ec2.getVpc({
id: foo.ids[__index],
})));
const testFlowLog: aws.ec2.FlowLog[] = [];
foo.ids.length.apply(rangeBody => {
for (let range = 0; range < rangeBody; range++) {
testFlowLog.push(new aws.ec2.FlowLog(`test_flow_log-${range}`, {vpcId: fooGetVpc.apply(fooGetVpc => fooGetVpc[range].id)}));
}
});
return {
foo: foo.ids,
};
}
import pulumi
from typing import Any
import pulumi_aws as aws
foo = aws.ec2.get_vpcs()
foo_get_vpc = [aws.ec2.get_vpc(id=foo.ids[__index]) for __index in len(foo.ids).apply(lambda length: range(length))]
test_flow_log: list[aws.ec2.FlowLog] = []
def create_test_flow_log(range_body):
for test_flow_log_range in [{"value": i} for i in range(0, range_body)]:
test_flow_log.append(aws.ec2.FlowLog(f"test_flow_log-{test_flow_log_range['value']}", vpc_id=foo_get_vpc.apply(lambda foo_get_vpc: foo_get_vpc[test_flow_log_range["value"]].id)))
(len(foo.ids)).apply(create_test_flow_log)
pulumi.export("foo", foo.ids)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.Ec2.GetVpcs.Invoke();
var fooGetVpc = ;
var testFlowLog = new List<Aws.Ec2.FlowLog>();
foo.Apply(getVpcsResult => getVpcsResult.Ids).Length().Apply(rangeBody =>
{
for (var rangeIndex = 0; rangeIndex < rangeBody; rangeIndex++)
{
var range = new { Value = rangeIndex };
testFlowLog.Add(new Aws.Ec2.FlowLog($"test_flow_log-{range.Value}", new()
{
VpcId = fooGetVpc.Apply(fooGetVpc => fooGetVpc[range.Value].Id),
}));
}
return 0;
});
return new Dictionary<string, object?>
{
["foo"] = foo.Apply(getVpcsResult => getVpcsResult.Ids),
};
});
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ec2_getvpcs" "foo" {
}
data "aws_ec2_getvpc" "invoke_1" {
for_each = toset(range(length(data.aws_ec2_getvpcs.foo.ids)))
id = data.aws_ec2_getvpcs.foo.ids[each.value]
}
resource "aws_ec2_flowlog" "test_flow_log" {
count = length(data.aws_ec2_getvpcs.foo.ids)
vpc_id = local.fooGetVpc[count.index].id
}
locals {
fooGetVpc = [for __index in range(length(data.aws_ec2_getvpcs.foo.ids)) : data.aws_ec2_getvpc.invoke_1[__index]]
}
output "foo" {
value = data.aws_ec2_getvpcs.foo.ids
}
args Arguments passed to this invoke. Arguments for getVpcs.
options Invoke options controlling this call.
Implementation
Future<GetVpcsResult> getVpcs(
GetVpcsArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:ec2/getVpcs:getVpcs',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetVpcsResult.fromMap(result);
}