@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
337 lines • 14.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* LbEdgeExtension is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.
*
* To get more information about LbEdgeExtension, see:
*
* * [API documentation](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.lbEdgeExtensions)
* * How-to Guides
* * [Configure a edge extension](https://cloud.google.com/service-extensions/docs/configure-edge-extensions)
*
* ## Example Usage
*
* ### Network Services Lb Edge Extension Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultBackendService = new gcp.compute.BackendService("default", {
* name: "elb-backend-subnet",
* portName: "http",
* protocol: "HTTP",
* timeoutSec: 10,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* });
* const defaultURLMap = new gcp.compute.URLMap("default", {
* name: "elb-url-map",
* description: "a description",
* defaultService: defaultBackendService.id,
* hostRules: [{
* hosts: ["mysite.com"],
* pathMatcher: "allpaths",
* }],
* pathMatchers: [{
* name: "allpaths",
* defaultService: defaultBackendService.id,
* pathRules: [{
* paths: ["/*"],
* service: defaultBackendService.id,
* }],
* }],
* });
* const defaultTargetHttpProxy = new gcp.compute.TargetHttpProxy("default", {
* name: "elb-target-http-proxy",
* description: "a description",
* urlMap: defaultURLMap.id,
* });
* // forwarding rule
* const _default = new gcp.compute.GlobalForwardingRule("default", {
* name: "elb-forwarding-rule",
* target: defaultTargetHttpProxy.id,
* portRange: "80",
* loadBalancingScheme: "EXTERNAL_MANAGED",
* networkTier: "PREMIUM",
* });
* const wasm_plugin = new gcp.networkservices.WasmPlugin("wasm-plugin", {
* name: "elb-wasm-plugin-data",
* description: "my wasm plugin",
* mainVersionId: "v1",
* labels: {
* test_label: "test_value",
* },
* logConfig: {
* enable: true,
* sampleRate: 1,
* minLogLevel: "WARN",
* },
* versions: [{
* versionName: "v1",
* description: "v1 version of my wasm plugin",
* imageUri: "projects/my-project-name/locations/us-central1/repositories/repository-standard/genericArtifacts/my-wasm-plugin:v1",
* labels: {
* test_label: "test_value",
* },
* }],
* });
* const defaultLbEdgeExtension = new gcp.networkservices.LbEdgeExtension("default", {
* name: "elb-edge-ext",
* description: "my edge extension",
* location: "global",
* loadBalancingScheme: "EXTERNAL_MANAGED",
* forwardingRules: [_default.selfLink],
* extensionChains: [{
* name: "chain1",
* matchCondition: {
* celExpression: "request.host == 'example.com'",
* },
* extensions: [{
* name: "ext11",
* service: wasm_plugin.id,
* failOpen: false,
* supportedEvents: ["REQUEST_HEADERS"],
* forwardHeaders: ["custom-header"],
* }],
* }],
* labels: {
* foo: "bar",
* },
* });
* ```
*
* ## Import
*
* LbEdgeExtension can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/lbEdgeExtensions/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, LbEdgeExtension can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/lbEdgeExtension:LbEdgeExtension default projects/{{project}}/locations/{{location}}/lbEdgeExtensions/{{name}}
* $ pulumi import gcp:networkservices/lbEdgeExtension:LbEdgeExtension default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:networkservices/lbEdgeExtension:LbEdgeExtension default {{location}}/{{name}}
* ```
*/
export declare class LbEdgeExtension extends pulumi.CustomResource {
/**
* Get an existing LbEdgeExtension 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?: LbEdgeExtensionState, opts?: pulumi.CustomResourceOptions): LbEdgeExtension;
/**
* Returns true if the given object is an instance of LbEdgeExtension. 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 LbEdgeExtension;
/**
* 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 human-readable description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* A set of ordered extension chains that contain the match conditions and extensions to execute.
* Match conditions for each extension chain are evaluated in sequence for a given request.
* The first extension chain that has a condition that matches the request is executed.
* Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
* Structure is documented below.
*/
readonly extensionChains: pulumi.Output<outputs.networkservices.LbEdgeExtensionExtensionChain[]>;
/**
* A list of references to the forwarding rules to which this service extension is attached.
* At least one forwarding rule is required. Only one LbEdgeExtension resource can be associated with a forwarding rule.
*/
readonly forwardingRules: pulumi.Output<string[]>;
/**
* Set of labels associated with the LbEdgeExtension resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* All forwarding rules referenced by this extension must share the same load balancing scheme.
* Possible values are: `EXTERNAL_MANAGED`.
*/
readonly loadBalancingScheme: pulumi.Output<string>;
/**
* The location of the edge extension
*/
readonly location: pulumi.Output<string>;
/**
* Name of the LbEdgeExtension resource in the following format: projects/{project}/locations/{location}/lbEdgeExtensions/{lbEdgeExtensions}
*/
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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a LbEdgeExtension 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: LbEdgeExtensionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LbEdgeExtension resources.
*/
export interface LbEdgeExtensionState {
/**
* 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 human-readable description of the resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* A set of ordered extension chains that contain the match conditions and extensions to execute.
* Match conditions for each extension chain are evaluated in sequence for a given request.
* The first extension chain that has a condition that matches the request is executed.
* Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
* Structure is documented below.
*/
extensionChains?: pulumi.Input<pulumi.Input<inputs.networkservices.LbEdgeExtensionExtensionChain>[] | undefined>;
/**
* A list of references to the forwarding rules to which this service extension is attached.
* At least one forwarding rule is required. Only one LbEdgeExtension resource can be associated with a forwarding rule.
*/
forwardingRules?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Set of labels associated with the LbEdgeExtension resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* All forwarding rules referenced by this extension must share the same load balancing scheme.
* Possible values are: `EXTERNAL_MANAGED`.
*/
loadBalancingScheme?: pulumi.Input<string | undefined>;
/**
* The location of the edge extension
*/
location?: pulumi.Input<string | undefined>;
/**
* Name of the LbEdgeExtension resource in the following format: projects/{project}/locations/{location}/lbEdgeExtensions/{lbEdgeExtensions}
*/
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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a LbEdgeExtension resource.
*/
export interface LbEdgeExtensionArgs {
/**
* 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 human-readable description of the resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* A set of ordered extension chains that contain the match conditions and extensions to execute.
* Match conditions for each extension chain are evaluated in sequence for a given request.
* The first extension chain that has a condition that matches the request is executed.
* Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
* Structure is documented below.
*/
extensionChains: pulumi.Input<pulumi.Input<inputs.networkservices.LbEdgeExtensionExtensionChain>[]>;
/**
* A list of references to the forwarding rules to which this service extension is attached.
* At least one forwarding rule is required. Only one LbEdgeExtension resource can be associated with a forwarding rule.
*/
forwardingRules: pulumi.Input<pulumi.Input<string>[]>;
/**
* Set of labels associated with the LbEdgeExtension resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* All forwarding rules referenced by this extension must share the same load balancing scheme.
* Possible values are: `EXTERNAL_MANAGED`.
*/
loadBalancingScheme: pulumi.Input<string>;
/**
* The location of the edge extension
*/
location: pulumi.Input<string>;
/**
* Name of the LbEdgeExtension resource in the following format: projects/{project}/locations/{location}/lbEdgeExtensions/{lbEdgeExtensions}
*/
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>;
}
//# sourceMappingURL=lbEdgeExtension.d.ts.map