AWS Classic v6.2.1, Sep 22 23

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.ec2.getVpc

Explore with Pulumi AI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

Using getVpc

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 getVpc(args: GetVpcArgs, opts?: InvokeOptions): Promise<GetVpcResult>
function getVpcOutput(args: GetVpcOutputArgs, opts?: InvokeOptions): Output<GetVpcResult>

def get_vpc(cidr_block: Optional[str] = None,
            default: Optional[bool] = None,
            dhcp_options_id: Optional[str] = None,
            filters: Optional[Sequence[GetVpcFilter]] = None,
            id: Optional[str] = None,
            state: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            opts: Optional[InvokeOptions] = None) -> GetVpcResult
def get_vpc_output(cidr_block: Optional[pulumi.Input[str]] = None,
            default: Optional[pulumi.Input[bool]] = None,
            dhcp_options_id: Optional[pulumi.Input[str]] = None,
            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpcFilterArgs]]]] = None,
            id: Optional[pulumi.Input[str]] = None,
            state: Optional[pulumi.Input[str]] = None,
            tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVpcResult]

func LookupVpc(ctx *Context, args *LookupVpcArgs, opts ...InvokeOption) (*LookupVpcResult, error)
func LookupVpcOutput(ctx *Context, args *LookupVpcOutputArgs, opts ...InvokeOption) LookupVpcResultOutput

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

public static class GetVpc 
{
    public static Task<GetVpcResult> InvokeAsync(GetVpcArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcResult> Invoke(GetVpcInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

CidrBlock string

Cidr block of the desired VPC.

Default bool

Boolean constraint on whether the desired VPC is the default VPC for the region.

DhcpOptionsId string

DHCP options id of the desired VPC.

Filters List<GetVpcFilter>

Custom filter block as described below.

Id string

ID of the specific VPC to retrieve.

State string

Current state of the desired VPC. Can be either "pending" or "available".

Tags Dictionary<string, string>

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

CidrBlock string

Cidr block of the desired VPC.

Default bool

Boolean constraint on whether the desired VPC is the default VPC for the region.

DhcpOptionsId string

DHCP options id of the desired VPC.

Filters []GetVpcFilter

Custom filter block as described below.

Id string

ID of the specific VPC to retrieve.

State string

Current state of the desired VPC. Can be either "pending" or "available".

Tags map[string]string

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

cidrBlock String

Cidr block of the desired VPC.

default_ Boolean

Boolean constraint on whether the desired VPC is the default VPC for the region.

dhcpOptionsId String

DHCP options id of the desired VPC.

filters List<GetVpcFilter>

Custom filter block as described below.

id String

ID of the specific VPC to retrieve.

state String

Current state of the desired VPC. Can be either "pending" or "available".

tags Map<String,String>

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

cidrBlock string

Cidr block of the desired VPC.

default boolean

Boolean constraint on whether the desired VPC is the default VPC for the region.

dhcpOptionsId string

DHCP options id of the desired VPC.

filters GetVpcFilter[]

Custom filter block as described below.

id string

ID of the specific VPC to retrieve.

state string

Current state of the desired VPC. Can be either "pending" or "available".

tags {[key: string]: string}

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

cidr_block str

Cidr block of the desired VPC.

default bool

Boolean constraint on whether the desired VPC is the default VPC for the region.

dhcp_options_id str

DHCP options id of the desired VPC.

filters Sequence[GetVpcFilter]

Custom filter block as described below.

id str

ID of the specific VPC to retrieve.

state str

Current state of the desired VPC. Can be either "pending" or "available".

tags Mapping[str, str]

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

cidrBlock String

Cidr block of the desired VPC.

default Boolean

Boolean constraint on whether the desired VPC is the default VPC for the region.

dhcpOptionsId String

DHCP options id of the desired VPC.

filters List<Property Map>

Custom filter block as described below.

id String

ID of the specific VPC to retrieve.

state String

Current state of the desired VPC. Can be either "pending" or "available".

tags Map<String>

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

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

getVpc Result

The following output properties are available:

Arn string: ARN of VPC
CidrBlock string: CIDR block for the association.
CidrBlockAssociations List<GetVpcCidrBlockAssociation>
Default bool
DhcpOptionsId string
EnableDnsHostnames bool: Whether or not the VPC has DNS hostname support
EnableDnsSupport bool: Whether or not the VPC has DNS support
EnableNetworkAddressUsageMetrics bool: Whether Network Address Usage metrics are enabled for your VPC
Id string
InstanceTenancy string: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
Ipv6AssociationId string: Association ID for the IPv6 CIDR block.
Ipv6CidrBlock string: IPv6 CIDR block.
MainRouteTableId string: ID of the main route table associated with this VPC.
OwnerId string: ID of the AWS account that owns the VPC.
State string: State of the association.
Tags Dictionary<string, string>
Filters List<GetVpcFilter>

Arn string: ARN of VPC
CidrBlock string: CIDR block for the association.
CidrBlockAssociations []GetVpcCidrBlockAssociation
Default bool
DhcpOptionsId string
EnableDnsHostnames bool: Whether or not the VPC has DNS hostname support
EnableDnsSupport bool: Whether or not the VPC has DNS support
EnableNetworkAddressUsageMetrics bool: Whether Network Address Usage metrics are enabled for your VPC
Id string
InstanceTenancy string: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
Ipv6AssociationId string: Association ID for the IPv6 CIDR block.
Ipv6CidrBlock string: IPv6 CIDR block.
MainRouteTableId string: ID of the main route table associated with this VPC.
OwnerId string: ID of the AWS account that owns the VPC.
State string: State of the association.
Tags map[string]string
Filters []GetVpcFilter

arn String: ARN of VPC
cidrBlock String: CIDR block for the association.
cidrBlockAssociations List<GetVpcCidrBlockAssociation>
default_ Boolean
dhcpOptionsId String
enableDnsHostnames Boolean: Whether or not the VPC has DNS hostname support
enableDnsSupport Boolean: Whether or not the VPC has DNS support
enableNetworkAddressUsageMetrics Boolean: Whether Network Address Usage metrics are enabled for your VPC
id String
instanceTenancy String: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
ipv6AssociationId String: Association ID for the IPv6 CIDR block.
ipv6CidrBlock String: IPv6 CIDR block.
mainRouteTableId String: ID of the main route table associated with this VPC.
ownerId String: ID of the AWS account that owns the VPC.
state String: State of the association.
tags Map<String,String>
filters List<GetVpcFilter>

arn string: ARN of VPC
cidrBlock string: CIDR block for the association.
cidrBlockAssociations GetVpcCidrBlockAssociation[]
default boolean
dhcpOptionsId string
enableDnsHostnames boolean: Whether or not the VPC has DNS hostname support
enableDnsSupport boolean: Whether or not the VPC has DNS support
enableNetworkAddressUsageMetrics boolean: Whether Network Address Usage metrics are enabled for your VPC
id string
instanceTenancy string: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
ipv6AssociationId string: Association ID for the IPv6 CIDR block.
ipv6CidrBlock string: IPv6 CIDR block.
mainRouteTableId string: ID of the main route table associated with this VPC.
ownerId string: ID of the AWS account that owns the VPC.
state string: State of the association.
tags {[key: string]: string}
filters GetVpcFilter[]

arn str: ARN of VPC
cidr_block str: CIDR block for the association.
cidr_block_associations Sequence[GetVpcCidrBlockAssociation]
default bool
dhcp_options_id str
enable_dns_hostnames bool: Whether or not the VPC has DNS hostname support
enable_dns_support bool: Whether or not the VPC has DNS support
enable_network_address_usage_metrics bool: Whether Network Address Usage metrics are enabled for your VPC
id str
instance_tenancy str: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
ipv6_association_id str: Association ID for the IPv6 CIDR block.
ipv6_cidr_block str: IPv6 CIDR block.
main_route_table_id str: ID of the main route table associated with this VPC.
owner_id str: ID of the AWS account that owns the VPC.
state str: State of the association.
tags Mapping[str, str]
filters Sequence[GetVpcFilter]

arn String: ARN of VPC
cidrBlock String: CIDR block for the association.
cidrBlockAssociations List<Property Map>
default Boolean
dhcpOptionsId String
enableDnsHostnames Boolean: Whether or not the VPC has DNS hostname support
enableDnsSupport Boolean: Whether or not the VPC has DNS support
enableNetworkAddressUsageMetrics Boolean: Whether Network Address Usage metrics are enabled for your VPC
id String
instanceTenancy String: Allowed tenancy of instances launched into the selected VPC. May be any of "default", "dedicated", or "host".
ipv6AssociationId String: Association ID for the IPv6 CIDR block.
ipv6CidrBlock String: IPv6 CIDR block.
mainRouteTableId String: ID of the main route table associated with this VPC.
ownerId String: ID of the AWS account that owns the VPC.
state String: State of the association.
tags Map<String>
filters List<Property Map>

Supporting Types

GetVpcCidrBlockAssociation

AssociationId string: Association ID for the IPv4 CIDR block.
CidrBlock string: Cidr block of the desired VPC.
State string: Current state of the desired VPC. Can be either "pending" or "available".

AssociationId string: Association ID for the IPv4 CIDR block.
CidrBlock string: Cidr block of the desired VPC.
State string: Current state of the desired VPC. Can be either "pending" or "available".

associationId String: Association ID for the IPv4 CIDR block.
cidrBlock String: Cidr block of the desired VPC.
state String: Current state of the desired VPC. Can be either "pending" or "available".

associationId string: Association ID for the IPv4 CIDR block.
cidrBlock string: Cidr block of the desired VPC.
state string: Current state of the desired VPC. Can be either "pending" or "available".

association_id str: Association ID for the IPv4 CIDR block.
cidr_block str: Cidr block of the desired VPC.
state str: Current state of the desired VPC. Can be either "pending" or "available".

associationId String: Association ID for the IPv4 CIDR block.
cidrBlock String: Cidr block of the desired VPC.
state String: Current state of the desired VPC. Can be either "pending" or "available".

GetVpcFilter

Name string: Name of the field to filter by, as defined by the underlying AWS API.
Values List<string>: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

Name string: Name of the field to filter by, as defined by the underlying AWS API.
Values []string: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

name String: Name of the field to filter by, as defined by the underlying AWS API.
values List<String>: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

name string: Name of the field to filter by, as defined by the underlying AWS API.
values string[]: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

name str: Name of the field to filter by, as defined by the underlying AWS API.
values Sequence[str]: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

name String: Name of the field to filter by, as defined by the underlying AWS API.
values List<String>: Set of values that are accepted for the given field. A VPC will be selected if any one of the given values matches.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.ec2.getVpc

On this page

On this page

Using getVpc

getVpc Result

Supporting Types

GetVpcCidrBlockAssociation

GetVpcFilter

Package Details

On this page

On this page