@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
220 lines • 8.18 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.RouteStage = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Creates and manages Scaleway Edge Services Route Stages.
*
* ## Example Usage
*
* ### Default to WAF with backend rules
*
* Routes all unmatched traffic through a WAF stage, while requests matching specific patterns are sent directly to a backend stage.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.edgeservices.RouteStage("main", {
* pipelineId: mainScalewayEdgeServicesPipeline.id,
* wafStageId: waf.id,
* rules: [{
* backendStageId: backend.id,
* ruleHttpMatch: {
* methodFilters: [
* "get",
* "post",
* ],
* pathFilter: {
* pathFilterType: "regex",
* value: ".*",
* },
* },
* }],
* });
* ```
*
* ### Host-based routing
*
* Routes requests to different backends based on the hostname, allowing a single pipeline to serve multiple domains.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.edgeservices.Pipeline("main", {
* name: "my-pipeline",
* description: "Multi-host pipeline with host-based routing",
* });
* const api = new scaleway.object.Bucket("api", {name: "my-api-bucket"});
* const static = new scaleway.object.Bucket("static", {name: "my-static-site"});
* const apiBackendStage = new scaleway.edgeservices.BackendStage("api", {
* pipelineId: main.id,
* s3BackendConfig: {
* bucketName: api.name,
* bucketRegion: "fr-par",
* },
* });
* const staticBackendStage = new scaleway.edgeservices.BackendStage("static", {
* pipelineId: main.id,
* s3BackendConfig: {
* bucketName: static.name,
* bucketRegion: "fr-par",
* },
* });
* const mainRouteStage = new scaleway.edgeservices.RouteStage("main", {
* pipelineId: main.id,
* backendStageId: staticBackendStage.id,
* rules: [{
* backendStageId: apiBackendStage.id,
* ruleHttpMatch: {
* hostFilter: {
* hostFilterType: "regex",
* value: "api\\.example\\.com",
* },
* },
* }],
* });
* ```
*
* ### Default to backend with selective WAF protection
*
* Serves static content directly from a backend by default, while routing API traffic through a WAF stage for protection against common web attacks.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.edgeservices.Pipeline("main", {
* name: "my-pipeline",
* description: "Static site with WAF-protected API",
* });
* const mainBucket = new scaleway.object.Bucket("main", {name: "my-static-site"});
* const static = new scaleway.edgeservices.BackendStage("static", {
* pipelineId: main.id,
* s3BackendConfig: {
* bucketName: mainBucket.name,
* bucketRegion: "fr-par",
* },
* });
* const api = new scaleway.edgeservices.WafStage("api", {
* pipelineId: main.id,
* backendStageId: static.id,
* mode: "enable",
* paranoiaLevel: 2,
* });
* const mainRouteStage = new scaleway.edgeservices.RouteStage("main", {
* pipelineId: main.id,
* backendStageId: static.id,
* rules: [{
* wafStageId: api.id,
* ruleHttpMatch: {
* methodFilters: [
* "get",
* "post",
* "put",
* "patch",
* "delete",
* ],
* pathFilter: {
* pathFilterType: "regex",
* value: "/api/.*",
* },
* },
* }],
* });
* ```
*
* ## Import
*
* Route stages can be imported using the `{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:edgeservices/routeStage:RouteStage basic 11111111-1111-1111-1111-111111111111
* ```
*/
class RouteStage extends pulumi.CustomResource {
/**
* Get an existing RouteStage 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, id, state, opts) {
return new RouteStage(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'scaleway:edgeservices/routeStage:RouteStage';
/**
* Returns true if the given object is an instance of RouteStage. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === RouteStage.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["backendStageId"] = state?.backendStageId;
resourceInputs["createdAt"] = state?.createdAt;
resourceInputs["pipelineId"] = state?.pipelineId;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["rules"] = state?.rules;
resourceInputs["updatedAt"] = state?.updatedAt;
resourceInputs["wafStageId"] = state?.wafStageId;
}
else {
const args = argsOrState;
if (args?.pipelineId === undefined && !opts.urn) {
throw new Error("Missing required property 'pipelineId'");
}
resourceInputs["backendStageId"] = args?.backendStageId;
resourceInputs["pipelineId"] = args?.pipelineId;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["rules"] = args?.rules;
resourceInputs["wafStageId"] = args?.wafStageId;
resourceInputs["createdAt"] = undefined /*out*/;
resourceInputs["updatedAt"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/edgeServicesRouteStage:EdgeServicesRouteStage" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(RouteStage.__pulumiType, name, resourceInputs, opts);
}
}
exports.RouteStage = RouteStage;
//# sourceMappingURL=routeStage.js.map