cpln.getGvc
Explore with Pulumi AI
Use this data source to access information about an existing Global Virtual Cloud (GVC) within Control Plane.
Required
- name (String) Name of the GVC.
Outputs
The following attributes are exported:
- cpln_id (String) The ID, in GUID format, of the GVC.
- name (String) Name of the GVC.
- alias (String) The alias name of the GVC.
- description (String) Description of the GVC.
- tags (Map of String) Key-value map of resource tags.
- self_link (String) Full link to this resource. Can be referenced by other resources.
- domain (String) Custom domain name used by associated workloads.
- locations (List of String) A list of locations making up the Global Virtual Cloud.
- pull_secrets (List of String) A list of pull secret names used to authenticate to any private image repository referenced by Workloads within the GVC.
- lightstep_tracing (Block List, Max: 1) (see below).
- otel_tracing (Block List, Max: 1) (see below).
- controlplane_tracing (Block List, Max: 1) (see below).
- load_balancer (Block List, Max: 1) (see below).
lightstep_tracing
- sampling (Int) Sampling percentage.
- endpoint (String) Tracing Endpoint Workload. Either the canonical endpoint or the internal endpoint.
- credentials (String) Full link to referenced Opaque Secret.
otel_tracing
- sampling (Int) Determines what percentage of requests should be traced.
- endpoint (String) Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- custom_tags (Map of String) Key-value map of custom tags.
controlplane_tracing
- sampling (Int) Determines what percentage of requests should be traced.
- custom_tags (Map of String) Key-value map of custom tags.
load_balancer
dedicated (Boolean) Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
trusted_proxies (Int) Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumiverse/cpln";
const gvc = cpln.getGvc({
name: "gvc-example",
});
export const gvcId = gvc.then(gvc => gvc.id);
export const gvcLocations = gvc.then(gvc => gvc.locations);
import pulumi
import pulumi_cpln as cpln
gvc = cpln.get_gvc(name="gvc-example")
pulumi.export("gvcId", gvc.id)
pulumi.export("gvcLocations", gvc.locations)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
gvc, err := cpln.LookupGvc(ctx, &cpln.LookupGvcArgs{
Name: "gvc-example",
}, nil)
if err != nil {
return err
}
ctx.Export("gvcId", gvc.Id)
ctx.Export("gvcLocations", gvc.Locations)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cpln = Pulumi.Cpln;
return await Deployment.RunAsync(() =>
{
var gvc = Cpln.GetGvc.Invoke(new()
{
Name = "gvc-example",
});
return new Dictionary<string, object?>
{
["gvcId"] = gvc.Apply(getGvcResult => getGvcResult.Id),
["gvcLocations"] = gvc.Apply(getGvcResult => getGvcResult.Locations),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cpln.CplnFunctions;
import com.pulumi.cpln.inputs.GetGvcArgs;
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 gvc = CplnFunctions.getGvc(GetGvcArgs.builder()
.name("gvc-example")
.build());
ctx.export("gvcId", gvc.id());
ctx.export("gvcLocations", gvc.locations());
}
}
variables:
gvc:
fn::invoke:
function: cpln:getGvc
arguments:
name: gvc-example
outputs:
gvcId: ${gvc.id}
gvcLocations: ${gvc.locations}
Using getGvc
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 getGvc(args: GetGvcArgs, opts?: InvokeOptions): Promise<GetGvcResult>
function getGvcOutput(args: GetGvcOutputArgs, opts?: InvokeOptions): Output<GetGvcResult>
def get_gvc(controlplane_tracing: Optional[GetGvcControlplaneTracing] = None,
domain: Optional[str] = None,
endpoint_naming_format: Optional[str] = None,
env: Optional[Mapping[str, str]] = None,
lightstep_tracing: Optional[GetGvcLightstepTracing] = None,
load_balancer: Optional[GetGvcLoadBalancer] = None,
locations: Optional[Sequence[str]] = None,
name: Optional[str] = None,
otel_tracing: Optional[GetGvcOtelTracing] = None,
pull_secrets: Optional[Sequence[str]] = None,
sidecar: Optional[GetGvcSidecar] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetGvcResult
def get_gvc_output(controlplane_tracing: Optional[pulumi.Input[GetGvcControlplaneTracingArgs]] = None,
domain: Optional[pulumi.Input[str]] = None,
endpoint_naming_format: Optional[pulumi.Input[str]] = None,
env: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
lightstep_tracing: Optional[pulumi.Input[GetGvcLightstepTracingArgs]] = None,
load_balancer: Optional[pulumi.Input[GetGvcLoadBalancerArgs]] = None,
locations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
otel_tracing: Optional[pulumi.Input[GetGvcOtelTracingArgs]] = None,
pull_secrets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
sidecar: Optional[pulumi.Input[GetGvcSidecarArgs]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGvcResult]
func LookupGvc(ctx *Context, args *LookupGvcArgs, opts ...InvokeOption) (*LookupGvcResult, error)
func LookupGvcOutput(ctx *Context, args *LookupGvcOutputArgs, opts ...InvokeOption) LookupGvcResultOutput
> Note: This function is named LookupGvc
in the Go SDK.
public static class GetGvc
{
public static Task<GetGvcResult> InvokeAsync(GetGvcArgs args, InvokeOptions? opts = null)
public static Output<GetGvcResult> Invoke(GetGvcInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGvcResult> getGvc(GetGvcArgs args, InvokeOptions options)
public static Output<GetGvcResult> getGvc(GetGvcArgs args, InvokeOptions options)
fn::invoke:
function: cpln:index/getGvc:getGvc
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Controlplane
Tracing Pulumiverse.Cpln. Inputs. Get Gvc Controlplane Tracing - Domain string
- Endpoint
Naming stringFormat - Env Dictionary<string, string>
- Lightstep
Tracing Pulumiverse.Cpln. Inputs. Get Gvc Lightstep Tracing - Load
Balancer Pulumiverse.Cpln. Inputs. Get Gvc Load Balancer - Locations List<string>
- Otel
Tracing Pulumiverse.Cpln. Inputs. Get Gvc Otel Tracing - Pull
Secrets List<string> - Sidecar
Pulumiverse.
Cpln. Inputs. Get Gvc Sidecar - Dictionary<string, string>
- Name string
- Controlplane
Tracing GetGvc Controlplane Tracing - Domain string
- Endpoint
Naming stringFormat - Env map[string]string
- Lightstep
Tracing GetGvc Lightstep Tracing - Load
Balancer GetGvc Load Balancer - Locations []string
- Otel
Tracing GetGvc Otel Tracing - Pull
Secrets []string - Sidecar
Get
Gvc Sidecar - map[string]string
- name String
- controlplane
Tracing GetGvc Controlplane Tracing - domain String
- endpoint
Naming StringFormat - env Map<String,String>
- lightstep
Tracing GetGvc Lightstep Tracing - load
Balancer GetGvc Load Balancer - locations List<String>
- otel
Tracing GetGvc Otel Tracing - pull
Secrets List<String> - sidecar
Get
Gvc Sidecar - Map<String,String>
- name string
- controlplane
Tracing GetGvc Controlplane Tracing - domain string
- endpoint
Naming stringFormat - env {[key: string]: string}
- lightstep
Tracing GetGvc Lightstep Tracing - load
Balancer GetGvc Load Balancer - locations string[]
- otel
Tracing GetGvc Otel Tracing - pull
Secrets string[] - sidecar
Get
Gvc Sidecar - {[key: string]: string}
- name str
- controlplane_
tracing GetGvc Controlplane Tracing - domain str
- endpoint_
naming_ strformat - env Mapping[str, str]
- lightstep_
tracing GetGvc Lightstep Tracing - load_
balancer GetGvc Load Balancer - locations Sequence[str]
- otel_
tracing GetGvc Otel Tracing - pull_
secrets Sequence[str] - sidecar
Get
Gvc Sidecar - Mapping[str, str]
- name String
- controlplane
Tracing Property Map - domain String
- endpoint
Naming StringFormat - env Map<String>
- lightstep
Tracing Property Map - load
Balancer Property Map - locations List<String>
- otel
Tracing Property Map - pull
Secrets List<String> - sidecar Property Map
- Map<String>
getGvc Result
The following output properties are available:
- Alias string
- Cpln
Id string - Description string
- Endpoint
Naming stringFormat - Id string
- Name string
- Self
Link string - Dictionary<string, string>
- Controlplane
Tracing Pulumiverse.Cpln. Outputs. Get Gvc Controlplane Tracing - Domain string
- Env Dictionary<string, string>
- Lightstep
Tracing Pulumiverse.Cpln. Outputs. Get Gvc Lightstep Tracing - Load
Balancer Pulumiverse.Cpln. Outputs. Get Gvc Load Balancer - Locations List<string>
- Otel
Tracing Pulumiverse.Cpln. Outputs. Get Gvc Otel Tracing - Pull
Secrets List<string> - Sidecar
Pulumiverse.
Cpln. Outputs. Get Gvc Sidecar
- Alias string
- Cpln
Id string - Description string
- Endpoint
Naming stringFormat - Id string
- Name string
- Self
Link string - map[string]string
- Controlplane
Tracing GetGvc Controlplane Tracing - Domain string
- Env map[string]string
- Lightstep
Tracing GetGvc Lightstep Tracing - Load
Balancer GetGvc Load Balancer - Locations []string
- Otel
Tracing GetGvc Otel Tracing - Pull
Secrets []string - Sidecar
Get
Gvc Sidecar
- alias String
- cpln
Id String - description String
- endpoint
Naming StringFormat - id String
- name String
- self
Link String - Map<String,String>
- controlplane
Tracing GetGvc Controlplane Tracing - domain String
- env Map<String,String>
- lightstep
Tracing GetGvc Lightstep Tracing - load
Balancer GetGvc Load Balancer - locations List<String>
- otel
Tracing GetGvc Otel Tracing - pull
Secrets List<String> - sidecar
Get
Gvc Sidecar
- alias string
- cpln
Id string - description string
- endpoint
Naming stringFormat - id string
- name string
- self
Link string - {[key: string]: string}
- controlplane
Tracing GetGvc Controlplane Tracing - domain string
- env {[key: string]: string}
- lightstep
Tracing GetGvc Lightstep Tracing - load
Balancer GetGvc Load Balancer - locations string[]
- otel
Tracing GetGvc Otel Tracing - pull
Secrets string[] - sidecar
Get
Gvc Sidecar
- alias str
- cpln_
id str - description str
- endpoint_
naming_ strformat - id str
- name str
- self_
link str - Mapping[str, str]
- controlplane_
tracing GetGvc Controlplane Tracing - domain str
- env Mapping[str, str]
- lightstep_
tracing GetGvc Lightstep Tracing - load_
balancer GetGvc Load Balancer - locations Sequence[str]
- otel_
tracing GetGvc Otel Tracing - pull_
secrets Sequence[str] - sidecar
Get
Gvc Sidecar
- alias String
- cpln
Id String - description String
- endpoint
Naming StringFormat - id String
- name String
- self
Link String - Map<String>
- controlplane
Tracing Property Map - domain String
- env Map<String>
- lightstep
Tracing Property Map - load
Balancer Property Map - locations List<String>
- otel
Tracing Property Map - pull
Secrets List<String> - sidecar Property Map
Supporting Types
GetGvcControlplaneTracing
- Sampling double
- Determines what percentage of requests should be traced.
- Dictionary<string, string>
- Key-value map of custom tags.
- Sampling float64
- Determines what percentage of requests should be traced.
- map[string]string
- Key-value map of custom tags.
- sampling Double
- Determines what percentage of requests should be traced.
- Map<String,String>
- Key-value map of custom tags.
- sampling number
- Determines what percentage of requests should be traced.
- {[key: string]: string}
- Key-value map of custom tags.
- sampling float
- Determines what percentage of requests should be traced.
- Mapping[str, str]
- Key-value map of custom tags.
- sampling Number
- Determines what percentage of requests should be traced.
- Map<String>
- Key-value map of custom tags.
GetGvcLightstepTracing
- Endpoint string
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- Sampling double
- Determines what percentage of requests should be traced.
- Credentials string
- Full link to referenced Opaque Secret.
- Dictionary<string, string>
- Key-value map of custom tags.
- Endpoint string
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- Sampling float64
- Determines what percentage of requests should be traced.
- Credentials string
- Full link to referenced Opaque Secret.
- map[string]string
- Key-value map of custom tags.
- endpoint String
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- sampling Double
- Determines what percentage of requests should be traced.
- credentials String
- Full link to referenced Opaque Secret.
- Map<String,String>
- Key-value map of custom tags.
- endpoint string
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- sampling number
- Determines what percentage of requests should be traced.
- credentials string
- Full link to referenced Opaque Secret.
- {[key: string]: string}
- Key-value map of custom tags.
- endpoint str
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- sampling float
- Determines what percentage of requests should be traced.
- credentials str
- Full link to referenced Opaque Secret.
- Mapping[str, str]
- Key-value map of custom tags.
- endpoint String
- Tracing Endpoint Workload. Either the canonical endpoint or internal endpoint.
- sampling Number
- Determines what percentage of requests should be traced.
- credentials String
- Full link to referenced Opaque Secret.
- Map<String>
- Key-value map of custom tags.
GetGvcLoadBalancer
- Trusted
Proxies int - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- Dedicated bool
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- Ipset string
- The link or the name of the IP Set that will be used for this load balancer.
- Multi
Zone Pulumiverse.Cpln. Inputs. Get Gvc Load Balancer Multi Zone - Redirect
Pulumiverse.
Cpln. Inputs. Get Gvc Load Balancer Redirect - Specify the url to be redirected to for different http status codes.
- Trusted
Proxies int - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- Dedicated bool
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- Ipset string
- The link or the name of the IP Set that will be used for this load balancer.
- Multi
Zone GetGvc Load Balancer Multi Zone - Redirect
Get
Gvc Load Balancer Redirect - Specify the url to be redirected to for different http status codes.
- trusted
Proxies Integer - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- dedicated Boolean
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- ipset String
- The link or the name of the IP Set that will be used for this load balancer.
- multi
Zone GetGvc Load Balancer Multi Zone - redirect
Get
Gvc Load Balancer Redirect - Specify the url to be redirected to for different http status codes.
- trusted
Proxies number - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- dedicated boolean
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- ipset string
- The link or the name of the IP Set that will be used for this load balancer.
- multi
Zone GetGvc Load Balancer Multi Zone - redirect
Get
Gvc Load Balancer Redirect - Specify the url to be redirected to for different http status codes.
- trusted_
proxies int - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- dedicated bool
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- ipset str
- The link or the name of the IP Set that will be used for this load balancer.
- multi_
zone GetGvc Load Balancer Multi Zone - redirect
Get
Gvc Load Balancer Redirect - Specify the url to be redirected to for different http status codes.
- trusted
Proxies Number - Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.
- dedicated Boolean
- Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.
- ipset String
- The link or the name of the IP Set that will be used for this load balancer.
- multi
Zone Property Map - redirect Property Map
- Specify the url to be redirected to for different http status codes.
GetGvcLoadBalancerMultiZone
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
GetGvcLoadBalancerRedirect
- Class
Pulumiverse.
Cpln. Inputs. Get Gvc Load Balancer Redirect Class - Specify the redirect url for all status codes in a class.
- Class
Get
Gvc Load Balancer Redirect Class - Specify the redirect url for all status codes in a class.
- class_
Get
Gvc Load Balancer Redirect Class - Specify the redirect url for all status codes in a class.
- class
Get
Gvc Load Balancer Redirect Class - Specify the redirect url for all status codes in a class.
- class_
Get
Gvc Load Balancer Redirect Class - Specify the redirect url for all status codes in a class.
- class Property Map
- Specify the redirect url for all status codes in a class.
GetGvcLoadBalancerRedirectClass
GetGvcOtelTracing
GetGvcSidecar
- Envoy string
- Envoy string
- envoy String
- envoy string
- envoy str
- envoy String
Package Details
- Repository
- cpln pulumiverse/pulumi-cpln
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cpln
Terraform Provider.