@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
311 lines (310 loc) • 8.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage waf custom page
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.waf.CustomPage("foo", {
* accurate: {
* accurateRules: [
* {
* httpObj: "request.uri",
* objType: 1,
* opretar: 2,
* property: 0,
* valueString: "tf",
* },
* {
* httpObj: "request.schema",
* objType: 0,
* opretar: 2,
* property: 0,
* valueString: "tf-2",
* },
* ],
* logic: 2,
* },
* advanced: 1,
* body: "tf-test-body",
* clientIp: "ALL",
* code: 403,
* contentType: "text/html",
* description: "tf-test",
* enable: 1,
* host: "www.123.com",
* pageMode: 1,
* policy: 1,
* projectName: "default",
* redirectUrl: "/test/tf/path",
* url: "/tf-test",
* });
* ```
*
* ## Import
*
* WafCustomPage can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:waf/customPage:CustomPage default resource_id:Host
* ```
*/
export declare class CustomPage extends pulumi.CustomResource {
/**
* Get an existing CustomPage 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?: CustomPageState, opts?: pulumi.CustomResourceOptions): CustomPage;
/**
* Returns true if the given object is an instance of CustomPage. 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 CustomPage;
/**
* Advanced conditions.
*/
readonly accurate: pulumi.Output<outputs.waf.CustomPageAccurate>;
/**
* Whether to configure advanced conditions.
*/
readonly advanced: pulumi.Output<number>;
/**
* The layout content of the response page.
*/
readonly body: pulumi.Output<string>;
/**
* Fill in ALL, which means this rule will take effect on all IP addresses.
*/
readonly clientIp: pulumi.Output<string>;
/**
* Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
*/
readonly code: pulumi.Output<number>;
/**
* The layout template of the response page. Required if PageMode=0 or 1.
*/
readonly contentType: pulumi.Output<string>;
/**
* Rule description.
*/
readonly description: pulumi.Output<string>;
/**
* Whether to enable the rule.
*/
readonly enable: pulumi.Output<number>;
/**
* The ID of the advanced conditional rule group.
*/
readonly groupId: pulumi.Output<number>;
/**
* Request header information.
*/
readonly header: pulumi.Output<string>;
/**
* Domain name to be protected.
*/
readonly host: pulumi.Output<string>;
/**
* The ID of Region.
*/
readonly isolationId: pulumi.Output<string>;
/**
* Rule name.
*/
readonly name: pulumi.Output<string>;
/**
* The layout template of the response page.
*/
readonly pageMode: pulumi.Output<number>;
/**
* Action to be taken on requests that match the rule.
*/
readonly policy: pulumi.Output<number>;
/**
* The name of the project to which your domain names belong.
*/
readonly projectName: pulumi.Output<string | undefined>;
/**
* The path where users should be redirected.
*/
readonly redirectUrl: pulumi.Output<string>;
/**
* Unique identification of the rules.
*/
readonly ruleTag: pulumi.Output<string>;
/**
* Rule update time.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Match the path.
*/
readonly url: pulumi.Output<string>;
/**
* Create a CustomPage 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: CustomPageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomPage resources.
*/
export interface CustomPageState {
/**
* Advanced conditions.
*/
accurate?: pulumi.Input<inputs.waf.CustomPageAccurate>;
/**
* Whether to configure advanced conditions.
*/
advanced?: pulumi.Input<number>;
/**
* The layout content of the response page.
*/
body?: pulumi.Input<string>;
/**
* Fill in ALL, which means this rule will take effect on all IP addresses.
*/
clientIp?: pulumi.Input<string>;
/**
* Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
*/
code?: pulumi.Input<number>;
/**
* The layout template of the response page. Required if PageMode=0 or 1.
*/
contentType?: pulumi.Input<string>;
/**
* Rule description.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the rule.
*/
enable?: pulumi.Input<number>;
/**
* The ID of the advanced conditional rule group.
*/
groupId?: pulumi.Input<number>;
/**
* Request header information.
*/
header?: pulumi.Input<string>;
/**
* Domain name to be protected.
*/
host?: pulumi.Input<string>;
/**
* The ID of Region.
*/
isolationId?: pulumi.Input<string>;
/**
* Rule name.
*/
name?: pulumi.Input<string>;
/**
* The layout template of the response page.
*/
pageMode?: pulumi.Input<number>;
/**
* Action to be taken on requests that match the rule.
*/
policy?: pulumi.Input<number>;
/**
* The name of the project to which your domain names belong.
*/
projectName?: pulumi.Input<string>;
/**
* The path where users should be redirected.
*/
redirectUrl?: pulumi.Input<string>;
/**
* Unique identification of the rules.
*/
ruleTag?: pulumi.Input<string>;
/**
* Rule update time.
*/
updateTime?: pulumi.Input<string>;
/**
* Match the path.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CustomPage resource.
*/
export interface CustomPageArgs {
/**
* Advanced conditions.
*/
accurate?: pulumi.Input<inputs.waf.CustomPageAccurate>;
/**
* Whether to configure advanced conditions.
*/
advanced?: pulumi.Input<number>;
/**
* The layout content of the response page.
*/
body?: pulumi.Input<string>;
/**
* Fill in ALL, which means this rule will take effect on all IP addresses.
*/
clientIp: pulumi.Input<string>;
/**
* Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
*/
code: pulumi.Input<number>;
/**
* The layout template of the response page. Required if PageMode=0 or 1.
*/
contentType?: pulumi.Input<string>;
/**
* Rule description.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the rule.
*/
enable: pulumi.Input<number>;
/**
* Domain name to be protected.
*/
host: pulumi.Input<string>;
/**
* Rule name.
*/
name?: pulumi.Input<string>;
/**
* The layout template of the response page.
*/
pageMode: pulumi.Input<number>;
/**
* Action to be taken on requests that match the rule.
*/
policy: pulumi.Input<number>;
/**
* The name of the project to which your domain names belong.
*/
projectName?: pulumi.Input<string>;
/**
* The path where users should be redirected.
*/
redirectUrl?: pulumi.Input<string>;
/**
* Match the path.
*/
url: pulumi.Input<string>;
}