@pulumiverse/cpln
Version:
A Pulumi package for creating and managing Control Plane (cpln) resources.
180 lines (179 loc) • 7.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class DomainRoute extends pulumi.CustomResource {
/**
* Get an existing DomainRoute 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?: DomainRouteState, opts?: pulumi.CustomResourceOptions): DomainRoute;
/**
* Returns true if the given object is an instance of DomainRoute. 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 DomainRoute;
/**
* The self link of the domain to add the route to.
*/
readonly domainLink: pulumi.Output<string>;
/**
* The port the route corresponds to. Default: 443
*/
readonly domainPort: pulumi.Output<number>;
/**
* Modify the headers for all http requests for this route.
*/
readonly headers: pulumi.Output<outputs.DomainRouteHeaders | undefined>;
/**
* This option allows forwarding traffic for different host headers to different workloads. This will only be used when the
* target GVC has dedicated load balancing enabled and the Domain is configured for wildcard support. Please contact us on
* Slack or at support@controlplane.com for additional details.
*/
readonly hostPrefix: pulumi.Output<string | undefined>;
/**
* A regex to match the host header. This will only be used when the target GVC has dedicated load balancing enabled and
* the Domain is configure for wildcard support. Contact your account manager for details.
*/
readonly hostRegex: pulumi.Output<string | undefined>;
/**
* For the linked workload, the port to route traffic to.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* The path will match any unmatched path prefixes for the subdomain.
*/
readonly prefix: pulumi.Output<string | undefined>;
/**
* Used to match URI paths. Uses the google re2 regex syntax.
*/
readonly regex: pulumi.Output<string | undefined>;
/**
* A path prefix can be configured to be replaced when forwarding the request to the Workload.
*/
readonly replacePrefix: pulumi.Output<string | undefined>;
/**
* The replica number of a stateful workload to route to. If not provided, traffic will be routed to all replicas.
*/
readonly replica: pulumi.Output<number | undefined>;
/**
* The link of the workload to map the prefix to.
*/
readonly workloadLink: pulumi.Output<string>;
/**
* Create a DomainRoute 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: DomainRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DomainRoute resources.
*/
export interface DomainRouteState {
/**
* The self link of the domain to add the route to.
*/
domainLink?: pulumi.Input<string>;
/**
* The port the route corresponds to. Default: 443
*/
domainPort?: pulumi.Input<number>;
/**
* Modify the headers for all http requests for this route.
*/
headers?: pulumi.Input<inputs.DomainRouteHeaders>;
/**
* This option allows forwarding traffic for different host headers to different workloads. This will only be used when the
* target GVC has dedicated load balancing enabled and the Domain is configured for wildcard support. Please contact us on
* Slack or at support@controlplane.com for additional details.
*/
hostPrefix?: pulumi.Input<string>;
/**
* A regex to match the host header. This will only be used when the target GVC has dedicated load balancing enabled and
* the Domain is configure for wildcard support. Contact your account manager for details.
*/
hostRegex?: pulumi.Input<string>;
/**
* For the linked workload, the port to route traffic to.
*/
port?: pulumi.Input<number>;
/**
* The path will match any unmatched path prefixes for the subdomain.
*/
prefix?: pulumi.Input<string>;
/**
* Used to match URI paths. Uses the google re2 regex syntax.
*/
regex?: pulumi.Input<string>;
/**
* A path prefix can be configured to be replaced when forwarding the request to the Workload.
*/
replacePrefix?: pulumi.Input<string>;
/**
* The replica number of a stateful workload to route to. If not provided, traffic will be routed to all replicas.
*/
replica?: pulumi.Input<number>;
/**
* The link of the workload to map the prefix to.
*/
workloadLink?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DomainRoute resource.
*/
export interface DomainRouteArgs {
/**
* The self link of the domain to add the route to.
*/
domainLink: pulumi.Input<string>;
/**
* The port the route corresponds to. Default: 443
*/
domainPort?: pulumi.Input<number>;
/**
* Modify the headers for all http requests for this route.
*/
headers?: pulumi.Input<inputs.DomainRouteHeaders>;
/**
* This option allows forwarding traffic for different host headers to different workloads. This will only be used when the
* target GVC has dedicated load balancing enabled and the Domain is configured for wildcard support. Please contact us on
* Slack or at support@controlplane.com for additional details.
*/
hostPrefix?: pulumi.Input<string>;
/**
* A regex to match the host header. This will only be used when the target GVC has dedicated load balancing enabled and
* the Domain is configure for wildcard support. Contact your account manager for details.
*/
hostRegex?: pulumi.Input<string>;
/**
* For the linked workload, the port to route traffic to.
*/
port?: pulumi.Input<number>;
/**
* The path will match any unmatched path prefixes for the subdomain.
*/
prefix?: pulumi.Input<string>;
/**
* Used to match URI paths. Uses the google re2 regex syntax.
*/
regex?: pulumi.Input<string>;
/**
* A path prefix can be configured to be replaced when forwarding the request to the Workload.
*/
replacePrefix?: pulumi.Input<string>;
/**
* The replica number of a stateful workload to route to. If not provided, traffic will be routed to all replicas.
*/
replica?: pulumi.Input<number>;
/**
* The link of the workload to map the prefix to.
*/
workloadLink: pulumi.Input<string>;
}