1. Packages
  2. Aviatrix
  3. API Docs
  4. getAviatrixVpc
Viewing docs for Aviatrix v0.0.11
published on Saturday, Jun 17, 2023 by Aviatrix
Schema (JSON)
astipkovits/pulumi-aviatrix

aviatrix.getAviatrixVpc

aviatrix logo
Viewing docs for Aviatrix v0.0.11
published on Saturday, Jun 17, 2023 by Aviatrix
Schema (JSON)
astipkovits/pulumi-aviatrix

    The aviatrix_vpc data source provides details about a specific VPC created by the Aviatrix Controller.

    This data source can prove useful when a module accepts any form of VPC detail as an input variable. For example, requiring a subnet CIDR specification when creating a gateway.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    var test = Aviatrix.GetAviatrixVpc.Invoke(new()
    {
        Name = "vpc-test",
    });

});

    package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = aviatrix.LookupAviatrixVpc(ctx, &GetAviatrixVpcArgs{
			Name: "vpc-test",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixFunctions;
import com.pulumi.aviatrix.inputs.GetAviatrixVpcArgs;
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 test = AviatrixFunctions.getAviatrixVpc(GetAviatrixVpcArgs.builder()
            .name("vpc-test")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Aviatrix VPC Data Source
const test = pulumi.output(aviatrix.getAviatrixVpc({
    name: "vpc-test",
}));

    import pulumi
import pulumi_aviatrix as aviatrix

test = aviatrix.get_aviatrix_vpc(name="vpc-test")

    variables:
  test:
    fn::invoke:
      Function: aviatrix:getAviatrixVpc
      Arguments:
        name: vpc-test

    Using getAviatrixVpc

    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 getAviatrixVpc(args: GetAviatrixVpcArgs, opts?: InvokeOptions): Promise<GetAviatrixVpcResult>
function getAviatrixVpcOutput(args: GetAviatrixVpcOutputArgs, opts?: InvokeOptions): Output<GetAviatrixVpcResult>
    def get_aviatrix_vpc(name: Optional[str] = None,
                     route_tables_filter: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAviatrixVpcResult
def get_aviatrix_vpc_output(name: Optional[pulumi.Input[str]] = None,
                     route_tables_filter: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAviatrixVpcResult]
    func LookupAviatrixVpc(ctx *Context, args *LookupAviatrixVpcArgs, opts ...InvokeOption) (*LookupAviatrixVpcResult, error)
func LookupAviatrixVpcOutput(ctx *Context, args *LookupAviatrixVpcOutputArgs, opts ...InvokeOption) LookupAviatrixVpcResultOutput

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

    public static class GetAviatrixVpc 
{
    public static Task<GetAviatrixVpcResult> InvokeAsync(GetAviatrixVpcArgs args, InvokeOptions? opts = null)
    public static Output<GetAviatrixVpcResult> Invoke(GetAviatrixVpcInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAviatrixVpcResult> getAviatrixVpc(GetAviatrixVpcArgs args, InvokeOptions options)
public static Output<GetAviatrixVpcResult> getAviatrixVpc(GetAviatrixVpcArgs args, InvokeOptions options)

    fn::invoke:
  function: aviatrix:index/getAviatrixVpc:getAviatrixVpc
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the Aviatrix VPC.
    RouteTablesFilter string
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.
    Name string
    Name of the Aviatrix VPC.
    RouteTablesFilter string
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.
    name String
    Name of the Aviatrix VPC.
    routeTablesFilter String
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.
    name string
    Name of the Aviatrix VPC.
    routeTablesFilter string
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.
    name str
    Name of the Aviatrix VPC.
    route_tables_filter str
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.
    name String
    Name of the Aviatrix VPC.
    routeTablesFilter String
    Filters the route_tables list to contain only public or private route tables. Valid values are 'private' or 'public'. If not set route_tables is not filtered.

    getAviatrixVpc Result

    The following output properties are available:

    AccountName string
    Account name of the VPC created.
    AvailabilityDomains List<string>
    List of OCI availability domains.
    AviatrixFirenetVpc bool
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    AviatrixTransitVpc bool
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    AzureVnetResourceId string
    Azure vnet resource ID.
    Cidr string
    Private subnet CIDR.
    CloudType int
    Type of cloud service provider.
    FaultDomains List<string>
    List of OCI fault domains.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Private subnet name.
    NumOfSubnetPairs int
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    PrivateSubnets List<GetAviatrixVpcPrivateSubnet>
    List of private subnet of the VPC(AWS, Azure) created.
    PublicSubnets List<GetAviatrixVpcPublicSubnet>
    List of public subnet of the VPC(AWS, Azure) created.
    Region string
    Region of the VPC created.
    ResourceGroup string
    Resource group of the Azure VPC created.
    RouteTables List<string>
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    SubnetSize int
    Subnet size. Only supported for AWS, Azure provider.
    Subnets List<GetAviatrixVpcSubnet>
    List of subnet of the VPC created.
    VpcId string
    ID of the VPC created.
    RouteTablesFilter string
    AccountName string
    Account name of the VPC created.
    AvailabilityDomains []string
    List of OCI availability domains.
    AviatrixFirenetVpc bool
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    AviatrixTransitVpc bool
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    AzureVnetResourceId string
    Azure vnet resource ID.
    Cidr string
    Private subnet CIDR.
    CloudType int
    Type of cloud service provider.
    FaultDomains []string
    List of OCI fault domains.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Private subnet name.
    NumOfSubnetPairs int
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    PrivateSubnets []GetAviatrixVpcPrivateSubnet
    List of private subnet of the VPC(AWS, Azure) created.
    PublicSubnets []GetAviatrixVpcPublicSubnet
    List of public subnet of the VPC(AWS, Azure) created.
    Region string
    Region of the VPC created.
    ResourceGroup string
    Resource group of the Azure VPC created.
    RouteTables []string
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    SubnetSize int
    Subnet size. Only supported for AWS, Azure provider.
    Subnets []GetAviatrixVpcSubnet
    List of subnet of the VPC created.
    VpcId string
    ID of the VPC created.
    RouteTablesFilter string
    accountName String
    Account name of the VPC created.
    availabilityDomains List<String>
    List of OCI availability domains.
    aviatrixFirenetVpc Boolean
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    aviatrixTransitVpc Boolean
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    azureVnetResourceId String
    Azure vnet resource ID.
    cidr String
    Private subnet CIDR.
    cloudType Integer
    Type of cloud service provider.
    faultDomains List<String>
    List of OCI fault domains.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Private subnet name.
    numOfSubnetPairs Integer
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    privateSubnets List<GetAviatrixVpcPrivateSubnet>
    List of private subnet of the VPC(AWS, Azure) created.
    publicSubnets List<GetAviatrixVpcPublicSubnet>
    List of public subnet of the VPC(AWS, Azure) created.
    region String
    Region of the VPC created.
    resourceGroup String
    Resource group of the Azure VPC created.
    routeTables List<String>
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    subnetSize Integer
    Subnet size. Only supported for AWS, Azure provider.
    subnets List<GetAviatrixVpcSubnet>
    List of subnet of the VPC created.
    vpcId String
    ID of the VPC created.
    routeTablesFilter String
    accountName string
    Account name of the VPC created.
    availabilityDomains string[]
    List of OCI availability domains.
    aviatrixFirenetVpc boolean
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    aviatrixTransitVpc boolean
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    azureVnetResourceId string
    Azure vnet resource ID.
    cidr string
    Private subnet CIDR.
    cloudType number
    Type of cloud service provider.
    faultDomains string[]
    List of OCI fault domains.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Private subnet name.
    numOfSubnetPairs number
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    privateSubnets GetAviatrixVpcPrivateSubnet[]
    List of private subnet of the VPC(AWS, Azure) created.
    publicSubnets GetAviatrixVpcPublicSubnet[]
    List of public subnet of the VPC(AWS, Azure) created.
    region string
    Region of the VPC created.
    resourceGroup string
    Resource group of the Azure VPC created.
    routeTables string[]
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    subnetSize number
    Subnet size. Only supported for AWS, Azure provider.
    subnets GetAviatrixVpcSubnet[]
    List of subnet of the VPC created.
    vpcId string
    ID of the VPC created.
    routeTablesFilter string
    account_name str
    Account name of the VPC created.
    availability_domains Sequence[str]
    List of OCI availability domains.
    aviatrix_firenet_vpc bool
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    aviatrix_transit_vpc bool
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    azure_vnet_resource_id str
    Azure vnet resource ID.
    cidr str
    Private subnet CIDR.
    cloud_type int
    Type of cloud service provider.
    fault_domains Sequence[str]
    List of OCI fault domains.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Private subnet name.
    num_of_subnet_pairs int
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    private_subnets Sequence[GetAviatrixVpcPrivateSubnet]
    List of private subnet of the VPC(AWS, Azure) created.
    public_subnets Sequence[GetAviatrixVpcPublicSubnet]
    List of public subnet of the VPC(AWS, Azure) created.
    region str
    Region of the VPC created.
    resource_group str
    Resource group of the Azure VPC created.
    route_tables Sequence[str]
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    subnet_size int
    Subnet size. Only supported for AWS, Azure provider.
    subnets Sequence[GetAviatrixVpcSubnet]
    List of subnet of the VPC created.
    vpc_id str
    ID of the VPC created.
    route_tables_filter str
    accountName String
    Account name of the VPC created.
    availabilityDomains List<String>
    List of OCI availability domains.
    aviatrixFirenetVpc Boolean
    Switch if the VPC created is an Aviatrix FireNet VPC or not.
    aviatrixTransitVpc Boolean
    Switch if the VPC created is an Aviatrix Transit VPC or not.
    azureVnetResourceId String
    Azure vnet resource ID.
    cidr String
    Private subnet CIDR.
    cloudType Number
    Type of cloud service provider.
    faultDomains List<String>
    List of OCI fault domains.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Private subnet name.
    numOfSubnetPairs Number
    Number of public subnet and private subnet pair created. Only supported for AWS, Azure provider.
    privateSubnets List<Property Map>
    List of private subnet of the VPC(AWS, Azure) created.
    publicSubnets List<Property Map>
    List of public subnet of the VPC(AWS, Azure) created.
    region String
    Region of the VPC created.
    resourceGroup String
    Resource group of the Azure VPC created.
    routeTables List<String>
    List of route table ids associated with this VPC. Only populated for AWS, AWSGov and Azure vpc.
    subnetSize Number
    Subnet size. Only supported for AWS, Azure provider.
    subnets List<Property Map>
    List of subnet of the VPC created.
    vpcId String
    ID of the VPC created.
    routeTablesFilter String

    Supporting Types

    GetAviatrixVpcPrivateSubnet

    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.
    cidr string
    Private subnet CIDR.
    name string
    Name of the Aviatrix VPC.
    subnetId string
    Private subnet ID.
    cidr str
    Private subnet CIDR.
    name str
    Name of the Aviatrix VPC.
    subnet_id str
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.

    GetAviatrixVpcPublicSubnet

    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.
    cidr string
    Private subnet CIDR.
    name string
    Name of the Aviatrix VPC.
    subnetId string
    Private subnet ID.
    cidr str
    Private subnet CIDR.
    name str
    Name of the Aviatrix VPC.
    subnet_id str
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.

    GetAviatrixVpcSubnet

    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    Cidr string
    Private subnet CIDR.
    Name string
    Name of the Aviatrix VPC.
    SubnetId string
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.
    cidr string
    Private subnet CIDR.
    name string
    Name of the Aviatrix VPC.
    subnetId string
    Private subnet ID.
    cidr str
    Private subnet CIDR.
    name str
    Name of the Aviatrix VPC.
    subnet_id str
    Private subnet ID.
    cidr String
    Private subnet CIDR.
    name String
    Name of the Aviatrix VPC.
    subnetId String
    Private subnet ID.

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Viewing docs for Aviatrix v0.0.11
    published on Saturday, Jun 17, 2023 by Aviatrix
    Schema (JSON)
    astipkovits/pulumi-aviatrix
      Try Pulumi Cloud free. Your team will thank you.