@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
472 lines • 17.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes.
*
* To get more information about TlsRoute, see:
*
* * [API documentation](https://cloud.google.com/traffic-director/docs/reference/network-services/rest/v1beta1/projects.locations.tlsRoutes)
*
* ## Example Usage
*
* ### Network Services Tls Route Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "backend-service-health-check",
* httpsHealthCheck: {
* port: 443,
* },
* });
* const _default = new gcp.compute.BackendService("default", {
* name: "my-backend-service",
* loadBalancingScheme: "INTERNAL_SELF_MANAGED",
* healthChecks: defaultHealthCheck.id,
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* description: "my description",
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* alpns: ["http/1.1"],
* }],
* action: {
* destinations: [{
* serviceName: _default.id,
* weight: 1,
* }],
* },
* }],
* });
* ```
* ### Network Services Tls Route Regional Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "backend-service-health-check",
* region: "europe-west4",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "my-backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* region: "europe-west4",
* healthChecks: defaultRegionHealthCheck.id,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* location: "europe-west4",
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* }],
* action: {
* destinations: [{
* serviceName: _default.selfLink,
* }],
* },
* }],
* });
* ```
* ### Network Services Tls Route Mesh Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "backend-service-health-check",
* httpsHealthCheck: {
* port: 443,
* },
* });
* const _default = new gcp.compute.BackendService("default", {
* name: "my-backend-service",
* loadBalancingScheme: "INTERNAL_SELF_MANAGED",
* healthChecks: defaultHealthCheck.id,
* });
* const defaultMesh = new gcp.networkservices.Mesh("default", {
* name: "my-tls-route",
* labels: {
* foo: "bar",
* },
* description: "my description",
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* description: "my description",
* meshes: [defaultMesh.id],
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* alpns: ["http/1.1"],
* }],
* action: {
* destinations: [{
* serviceName: _default.id,
* weight: 1,
* }],
* },
* }],
* });
* ```
* ### Network Services Tls Route Gateway Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "backend-service-health-check",
* httpsHealthCheck: {
* port: 443,
* },
* });
* const _default = new gcp.compute.BackendService("default", {
* name: "my-backend-service",
* loadBalancingScheme: "INTERNAL_SELF_MANAGED",
* healthChecks: defaultHealthCheck.id,
* });
* const defaultGateway = new gcp.networkservices.Gateway("default", {
* name: "my-tls-route",
* labels: {
* foo: "bar",
* },
* description: "my description",
* scope: "my-scope",
* type: "OPEN_MESH",
* ports: [443],
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* description: "my description",
* gateways: [defaultGateway.id],
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* alpns: ["http/1.1"],
* }],
* action: {
* destinations: [{
* serviceName: _default.id,
* weight: 1,
* }],
* },
* }],
* });
* ```
* ### Network Services Tls Route Target Tcp Proxy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "my-health-check",
* httpsHealthCheck: {
* port: 443,
* },
* });
* const _default = new gcp.compute.BackendService("default", {
* name: "my-backend-service",
* loadBalancingScheme: "INTERNAL_MANAGED",
* protocol: "TCP",
* healthChecks: defaultHealthCheck.id,
* });
* const defaultTargetTCPProxy = new gcp.compute.TargetTCPProxy("default", {
* name: "my-target-tcp-proxy",
* loadBalancingScheme: "INTERNAL_MANAGED",
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* targetProxies: [defaultTargetTCPProxy.id],
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* }],
* action: {
* destinations: [{
* serviceName: _default.id,
* }],
* },
* }],
* });
* ```
* ### Network Services Tls Route Region Target Tcp Proxy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "my-health-check",
* region: "europe-west4",
* timeoutSec: 1,
* checkIntervalSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "my-backend-service",
* protocol: "TCP",
* timeoutSec: 10,
* region: "europe-west4",
* healthChecks: defaultRegionHealthCheck.id,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultRegionTargetTcpProxy = new gcp.compute.RegionTargetTcpProxy("default", {
* name: "my-target-tcp-proxy",
* region: "europe-west4",
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultTlsRoute = new gcp.networkservices.TlsRoute("default", {
* name: "my-tls-route",
* location: "europe-west4",
* targetProxies: [defaultRegionTargetTcpProxy.selfLink],
* rules: [{
* matches: [{
* sniHosts: ["example.com"],
* }],
* action: {
* destinations: [{
* serviceName: _default.selfLink,
* }],
* },
* }],
* });
* ```
*
* ## Import
*
* TlsRoute can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/tlsRoutes/{{name}}`
* * `projects/{{project}}/locations/global/tlsRoutes/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, TlsRoute can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/tlsRoute:TlsRoute default projects/{{project}}/locations/{{location}}/tlsRoutes/{{name}}
* $ pulumi import gcp:networkservices/tlsRoute:TlsRoute default projects/{{project}}/locations/global/tlsRoutes/{{name}}
* $ pulumi import gcp:networkservices/tlsRoute:TlsRoute default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:networkservices/tlsRoute:TlsRoute default {{location}}/{{name}}
* ```
*/
export declare class TlsRoute extends pulumi.CustomResource {
/**
* Get an existing TlsRoute 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?: TlsRouteState, opts?: pulumi.CustomResourceOptions): TlsRoute;
/**
* Returns true if the given object is an instance of TlsRoute. 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 TlsRoute;
/**
* Time the TlsRoute was created in UTC.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway.
* Each gateway reference should match the pattern: projects/*/locations/*/gateways/<gateway_name>
*/
readonly gateways: pulumi.Output<string[] | undefined>;
/**
* Location (region) of the TLS Route.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh.
* Each mesh reference should match the pattern: projects/*/locations/*/meshes/<mesh_name>
* The attached Mesh should be of a type SIDECAR
*/
readonly meshes: pulumi.Output<string[] | undefined>;
/**
* Name of the TlsRoute resource.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Rules that define how traffic is routed and handled.
* Structure is documented below.
*/
readonly rules: pulumi.Output<outputs.networkservices.TlsRouteRule[]>;
/**
* Server-defined URL of this resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* TargetProxies defines a list of target proxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the load balancer.
* Each target proxy reference should match the pattern: projects/*/locations/global/targetTcpProxies/<target_tcp_proxy_name>
*/
readonly targetProxies: pulumi.Output<string[] | undefined>;
/**
* Time the TlsRoute was updated in UTC.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a TlsRoute 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: TlsRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TlsRoute resources.
*/
export interface TlsRouteState {
/**
* Time the TlsRoute was created in UTC.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway.
* Each gateway reference should match the pattern: projects/*/locations/*/gateways/<gateway_name>
*/
gateways?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Location (region) of the TLS Route.
*/
location?: pulumi.Input<string | undefined>;
/**
* Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh.
* Each mesh reference should match the pattern: projects/*/locations/*/meshes/<mesh_name>
* The attached Mesh should be of a type SIDECAR
*/
meshes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Name of the TlsRoute resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Rules that define how traffic is routed and handled.
* Structure is documented below.
*/
rules?: pulumi.Input<pulumi.Input<inputs.networkservices.TlsRouteRule>[] | undefined>;
/**
* Server-defined URL of this resource.
*/
selfLink?: pulumi.Input<string | undefined>;
/**
* TargetProxies defines a list of target proxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the load balancer.
* Each target proxy reference should match the pattern: projects/*/locations/global/targetTcpProxies/<target_tcp_proxy_name>
*/
targetProxies?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Time the TlsRoute was updated in UTC.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a TlsRoute resource.
*/
export interface TlsRouteArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway.
* Each gateway reference should match the pattern: projects/*/locations/*/gateways/<gateway_name>
*/
gateways?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Location (region) of the TLS Route.
*/
location?: pulumi.Input<string | undefined>;
/**
* Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh.
* Each mesh reference should match the pattern: projects/*/locations/*/meshes/<mesh_name>
* The attached Mesh should be of a type SIDECAR
*/
meshes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Name of the TlsRoute resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Rules that define how traffic is routed and handled.
* Structure is documented below.
*/
rules: pulumi.Input<pulumi.Input<inputs.networkservices.TlsRouteRule>[]>;
/**
* TargetProxies defines a list of target proxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the load balancer.
* Each target proxy reference should match the pattern: projects/*/locations/global/targetTcpProxies/<target_tcp_proxy_name>
*/
targetProxies?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=tlsRoute.d.ts.map