getVpcs

suspend fun getVpcs(argument: GetVpcsPlainArgs): GetVpcsResult

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/v6/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]interface{}{
"service": "production",
},
}, nil)
if err != nil {
return err
}
ctx.Export("foo", foo.Ids)
return nil
})
}
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.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 foo = Ec2Functions.getVpcs(GetVpcsArgs.builder()
.tags(Map.of("service", "production"))
.build());
ctx.export("foo", foo.applyValue(getVpcsResult -> getVpcsResult.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[] = [];
for (const range = {value: 0}; range.value < foo.ids.length; range.value++) {
testFlowLog.push(new aws.ec2.FlowLog(`test_flow_log-${range.value}`, {vpcId: fooGetVpc[range&#46;value].id}));
}
return {
foo: foo.ids,
};
}
import pulumi
import pulumi_aws as aws
foo = aws.ec2.get_vpcs()
foo_get_vpc = [aws&#46;ec2&#46;get_vpc(id=foo&#46;ids[__index]) for __index in range(len(foo&#46;ids))]
test_flow_log = []
for range in [{"value": i} for i in range(0, len(foo&#46;ids))]:
test_flow_log.append(aws.ec2.FlowLog(f"test_flow_log-{range['value']}", vpc_id=foo_get_vpc[range["value"]].id))
pulumi.export("foo", foo.ids)
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(async() =>
{
var foo = await Aws.Ec2.GetVpcs.InvokeAsync();
var fooGetVpc = ;
var testFlowLog = new List<Aws.Ec2.FlowLog>();
for (var rangeIndex = 0; rangeIndex < foo.Ids.Length; rangeIndex++)
{
var range = new { Value = rangeIndex };
testFlowLog.Add(new Aws.Ec2.FlowLog($"test_flow_log-{range.Value}", new()
{
VpcId = fooGetVpc[range&#46;Value].Id,
}));
}
return new Dictionary<string, object?>
{
["foo"] = foo.Ids,
};
});

Return

A collection of values returned by getVpcs.

Parameters

argument

A collection of arguments for invoking getVpcs.


suspend fun getVpcs(filters: List<GetVpcsFilter>? = null, tags: Map<String, String>? = null): GetVpcsResult

Return

A collection of values returned by getVpcs.

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:

tags

Map of tags, each pair of which must exactly match a pair on the desired vpcs.

See also


suspend fun getVpcs(argument: suspend GetVpcsPlainArgsBuilder.() -> Unit): GetVpcsResult

Return

A collection of values returned by getVpcs.

Parameters

argument

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

See also