@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
207 lines (206 loc) • 7.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class Gvc extends pulumi.CustomResource {
/**
* Get an existing Gvc resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GvcState, opts?: pulumi.CustomResourceOptions): Gvc;
/**
* Returns true if the given object is an instance of Gvc. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Gvc;
/**
* The alias name of the GVC.
*/
readonly alias: pulumi.Output<string>;
readonly controlplaneTracing: pulumi.Output<outputs.GvcControlplaneTracing | undefined>;
/**
* The ID, in GUID format, of the Global Virtual Cloud.
*/
readonly cplnId: pulumi.Output<string>;
/**
* Description of the Global Virtual Cloud.
*/
readonly description: pulumi.Output<string>;
/**
* Custom domain name used by associated workloads.
*
* @deprecated Selecting a domain on a GVC will be deprecated in the future. Use the 'cpln_domain resource' instead.
*/
readonly domain: pulumi.Output<string | undefined>;
/**
* Customizes the subdomain format for the canonical workload endpoint. `default` leaves it as
* '${workloadName}-${gvcName}.cpln.app'. `org` follows the scheme '${workloadName}-${gvcName}.${org}.cpln.app'.
*/
readonly endpointNamingFormat: pulumi.Output<string>;
/**
* Key-value array of resource environment variables.
*/
readonly env: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly lightstepTracing: pulumi.Output<outputs.GvcLightstepTracing | undefined>;
/**
* Dedicated load balancer configuration.
*/
readonly loadBalancer: pulumi.Output<outputs.GvcLoadBalancer | undefined>;
/**
* A list of [locations](https://docs.controlplane.com/reference/location#current) making up the Global Virtual Cloud.
*/
readonly locations: pulumi.Output<string[] | undefined>;
/**
* Name of the Global Virtual Cloud.
*/
readonly name: pulumi.Output<string>;
readonly otelTracing: pulumi.Output<outputs.GvcOtelTracing | undefined>;
/**
* A list of [pull secret](https://docs.controlplane.com/reference/gvc#pull-secrets) names used to authenticate to any
* private image repository referenced by Workloads within the GVC.
*/
readonly pullSecrets: pulumi.Output<string[] | undefined>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
readonly selfLink: pulumi.Output<string>;
readonly sidecar: pulumi.Output<outputs.GvcSidecar | undefined>;
/**
* Key-value map of resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Gvc resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: GvcArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Gvc resources.
*/
export interface GvcState {
/**
* The alias name of the GVC.
*/
alias?: pulumi.Input<string>;
controlplaneTracing?: pulumi.Input<inputs.GvcControlplaneTracing>;
/**
* The ID, in GUID format, of the Global Virtual Cloud.
*/
cplnId?: pulumi.Input<string>;
/**
* Description of the Global Virtual Cloud.
*/
description?: pulumi.Input<string>;
/**
* Custom domain name used by associated workloads.
*
* @deprecated Selecting a domain on a GVC will be deprecated in the future. Use the 'cpln_domain resource' instead.
*/
domain?: pulumi.Input<string>;
/**
* Customizes the subdomain format for the canonical workload endpoint. `default` leaves it as
* '${workloadName}-${gvcName}.cpln.app'. `org` follows the scheme '${workloadName}-${gvcName}.${org}.cpln.app'.
*/
endpointNamingFormat?: pulumi.Input<string>;
/**
* Key-value array of resource environment variables.
*/
env?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
lightstepTracing?: pulumi.Input<inputs.GvcLightstepTracing>;
/**
* Dedicated load balancer configuration.
*/
loadBalancer?: pulumi.Input<inputs.GvcLoadBalancer>;
/**
* A list of [locations](https://docs.controlplane.com/reference/location#current) making up the Global Virtual Cloud.
*/
locations?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the Global Virtual Cloud.
*/
name?: pulumi.Input<string>;
otelTracing?: pulumi.Input<inputs.GvcOtelTracing>;
/**
* A list of [pull secret](https://docs.controlplane.com/reference/gvc#pull-secrets) names used to authenticate to any
* private image repository referenced by Workloads within the GVC.
*/
pullSecrets?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Full link to this resource. Can be referenced by other resources.
*/
selfLink?: pulumi.Input<string>;
sidecar?: pulumi.Input<inputs.GvcSidecar>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Gvc resource.
*/
export interface GvcArgs {
controlplaneTracing?: pulumi.Input<inputs.GvcControlplaneTracing>;
/**
* Description of the Global Virtual Cloud.
*/
description?: pulumi.Input<string>;
/**
* Custom domain name used by associated workloads.
*
* @deprecated Selecting a domain on a GVC will be deprecated in the future. Use the 'cpln_domain resource' instead.
*/
domain?: pulumi.Input<string>;
/**
* Customizes the subdomain format for the canonical workload endpoint. `default` leaves it as
* '${workloadName}-${gvcName}.cpln.app'. `org` follows the scheme '${workloadName}-${gvcName}.${org}.cpln.app'.
*/
endpointNamingFormat?: pulumi.Input<string>;
/**
* Key-value array of resource environment variables.
*/
env?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
lightstepTracing?: pulumi.Input<inputs.GvcLightstepTracing>;
/**
* Dedicated load balancer configuration.
*/
loadBalancer?: pulumi.Input<inputs.GvcLoadBalancer>;
/**
* A list of [locations](https://docs.controlplane.com/reference/location#current) making up the Global Virtual Cloud.
*/
locations?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the Global Virtual Cloud.
*/
name?: pulumi.Input<string>;
otelTracing?: pulumi.Input<inputs.GvcOtelTracing>;
/**
* A list of [pull secret](https://docs.controlplane.com/reference/gvc#pull-secrets) names used to authenticate to any
* private image repository referenced by Workloads within the GVC.
*/
pullSecrets?: pulumi.Input<pulumi.Input<string>[]>;
sidecar?: pulumi.Input<inputs.GvcSidecar>;
/**
* Key-value map of resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}