hcp logo
HashiCorp Cloud Platform (HCP) v0.1.14, Dec 2 22

hcp.getHvn

The HVN data source provides information about an existing HashiCorp Virtual Network.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Hcp.GetHvn.Invoke(new()
    {
        HvnId = @var.Hvn_id,
    });

});
package main

import (
	"github.com/grapl-security/pulumi-hcp/sdk/go/hcp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hcp.LookupHvn(ctx, &GetHvnArgs{
			HvnId: _var.Hvn_id,
		}, 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.hcp.HcpFunctions;
import com.pulumi.hcp.inputs.GetHvnArgs;
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 example = HcpFunctions.getHvn(GetHvnArgs.builder()
            .hvnId(var_.hvn_id())
            .build());

    }
}
import pulumi
import pulumi_hcp as hcp

example = hcp.get_hvn(hvn_id=var["hvn_id"])
import * as pulumi from "@pulumi/pulumi";
import * as hcp from "@pulumi/hcp";

const example = hcp.getHvn({
    hvnId: _var.hvn_id,
});
variables:
  example:
    Fn::Invoke:
      Function: hcp:getHvn
      Arguments:
        hvnId: ${var.hvn_id}

Using getHvn

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 getHvn(args: GetHvnArgs, opts?: InvokeOptions): Promise<GetHvnResult>
function getHvnOutput(args: GetHvnOutputArgs, opts?: InvokeOptions): Output<GetHvnResult>
def get_hvn(hvn_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetHvnResult
def get_hvn_output(hvn_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetHvnResult]
func LookupHvn(ctx *Context, args *LookupHvnArgs, opts ...InvokeOption) (*LookupHvnResult, error)
func LookupHvnOutput(ctx *Context, args *LookupHvnOutputArgs, opts ...InvokeOption) LookupHvnResultOutput

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

public static class GetHvn 
{
    public static Task<GetHvnResult> InvokeAsync(GetHvnArgs args, InvokeOptions? opts = null)
    public static Output<GetHvnResult> Invoke(GetHvnInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHvnResult> getHvn(GetHvnArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: hcp:index/getHvn:getHvn
  arguments:
    # arguments dictionary

The following arguments are supported:

HvnId string

The ID of the HashiCorp Virtual Network (HVN).

HvnId string

The ID of the HashiCorp Virtual Network (HVN).

hvnId String

The ID of the HashiCorp Virtual Network (HVN).

hvnId string

The ID of the HashiCorp Virtual Network (HVN).

hvn_id str

The ID of the HashiCorp Virtual Network (HVN).

hvnId String

The ID of the HashiCorp Virtual Network (HVN).

getHvn Result

The following output properties are available:

CidrBlock string

The CIDR range of the HVN.

CloudProvider string

The provider where the HVN is located.

CreatedAt string

The time that the HVN was created.

HvnId string

The ID of the HashiCorp Virtual Network (HVN).

Id string

The provider-assigned unique ID for this managed resource.

OrganizationId string

The ID of the HCP organization where the HVN is located.

ProjectId string

The ID of the HCP project where the HVN is located.

ProviderAccountId string

The provider account ID where the HVN is located.

Region string

The region where the HVN is located.

SelfLink string

A unique URL identifying the HVN.

State string

The state of the HVN route.

CidrBlock string

The CIDR range of the HVN.

CloudProvider string

The provider where the HVN is located.

CreatedAt string

The time that the HVN was created.

HvnId string

The ID of the HashiCorp Virtual Network (HVN).

Id string

The provider-assigned unique ID for this managed resource.

OrganizationId string

The ID of the HCP organization where the HVN is located.

ProjectId string

The ID of the HCP project where the HVN is located.

ProviderAccountId string

The provider account ID where the HVN is located.

Region string

The region where the HVN is located.

SelfLink string

A unique URL identifying the HVN.

State string

The state of the HVN route.

cidrBlock String

The CIDR range of the HVN.

cloudProvider String

The provider where the HVN is located.

createdAt String

The time that the HVN was created.

hvnId String

The ID of the HashiCorp Virtual Network (HVN).

id String

The provider-assigned unique ID for this managed resource.

organizationId String

The ID of the HCP organization where the HVN is located.

projectId String

The ID of the HCP project where the HVN is located.

providerAccountId String

The provider account ID where the HVN is located.

region String

The region where the HVN is located.

selfLink String

A unique URL identifying the HVN.

state String

The state of the HVN route.

cidrBlock string

The CIDR range of the HVN.

cloudProvider string

The provider where the HVN is located.

createdAt string

The time that the HVN was created.

hvnId string

The ID of the HashiCorp Virtual Network (HVN).

id string

The provider-assigned unique ID for this managed resource.

organizationId string

The ID of the HCP organization where the HVN is located.

projectId string

The ID of the HCP project where the HVN is located.

providerAccountId string

The provider account ID where the HVN is located.

region string

The region where the HVN is located.

selfLink string

A unique URL identifying the HVN.

state string

The state of the HVN route.

cidr_block str

The CIDR range of the HVN.

cloud_provider str

The provider where the HVN is located.

created_at str

The time that the HVN was created.

hvn_id str

The ID of the HashiCorp Virtual Network (HVN).

id str

The provider-assigned unique ID for this managed resource.

organization_id str

The ID of the HCP organization where the HVN is located.

project_id str

The ID of the HCP project where the HVN is located.

provider_account_id str

The provider account ID where the HVN is located.

region str

The region where the HVN is located.

self_link str

A unique URL identifying the HVN.

state str

The state of the HVN route.

cidrBlock String

The CIDR range of the HVN.

cloudProvider String

The provider where the HVN is located.

createdAt String

The time that the HVN was created.

hvnId String

The ID of the HashiCorp Virtual Network (HVN).

id String

The provider-assigned unique ID for this managed resource.

organizationId String

The ID of the HCP organization where the HVN is located.

projectId String

The ID of the HCP project where the HVN is located.

providerAccountId String

The provider account ID where the HVN is located.

region String

The region where the HVN is located.

selfLink String

A unique URL identifying the HVN.

state String

The state of the HVN route.

Package Details

Repository
hcp grapl-security/pulumi-hcp
License
Apache-2.0
Notes

This Pulumi package is based on the hcp Terraform Provider.