@pulumi/fastly
Version:
A Pulumi package for creating and managing fastly cloud resources.. Based on terraform-provider-fastly: version v4
120 lines (119 loc) • 4.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Fastly Next-Gen WAF Workspace Signal, scoped to a specific NGWAF workspace.\
* These signals define conditions and actions that trigger WAF enforcement at the workspace level.
*
* ## Example Usage
*
* Basic usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fastly from "@pulumi/fastly";
*
* const example = new fastly.NgwafWorkspace("example", {
* name: "example",
* description: "Test NGWAF Workspace",
* mode: "block",
* ipAnonymization: "hashed",
* clientIpHeaders: [
* "X-Forwarded-For",
* "X-Real-IP",
* ],
* defaultBlockingResponseCode: 429,
* attackSignalThresholds: {},
* });
* const exampleNgwafWorkspaceSignal = new fastly.NgwafWorkspaceSignal("example", {
* workspaceId: example.id,
* description: "example",
* name: "Test Name",
* });
* ```
*
* ## Import
*
* Fastly Next-Gen WAF workspace signals can be imported using the format `<workspaceID>/<signalID>`, e.g.:
*
* ```sh
* $ pulumi import fastly:index/ngwafWorkspaceSignal:NgwafWorkspaceSignal demo <workspaceID>/<signalID>
* ```
*/
export declare class NgwafWorkspaceSignal extends pulumi.CustomResource {
/**
* Get an existing NgwafWorkspaceSignal 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?: NgwafWorkspaceSignalState, opts?: pulumi.CustomResourceOptions): NgwafWorkspaceSignal;
/**
* Returns true if the given object is an instance of NgwafWorkspaceSignal. 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 NgwafWorkspaceSignal;
/**
* The description of the signal.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the signal. Special characters and periods are not accepted.
*/
readonly name: pulumi.Output<string>;
/**
* The generated reference ID of the signal.
*/
readonly referenceId: pulumi.Output<string>;
/**
* The ID of the workspace.
*/
readonly workspaceId: pulumi.Output<string>;
/**
* Create a NgwafWorkspaceSignal 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: NgwafWorkspaceSignalArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NgwafWorkspaceSignal resources.
*/
export interface NgwafWorkspaceSignalState {
/**
* The description of the signal.
*/
description?: pulumi.Input<string>;
/**
* The name of the signal. Special characters and periods are not accepted.
*/
name?: pulumi.Input<string>;
/**
* The generated reference ID of the signal.
*/
referenceId?: pulumi.Input<string>;
/**
* The ID of the workspace.
*/
workspaceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NgwafWorkspaceSignal resource.
*/
export interface NgwafWorkspaceSignalArgs {
/**
* The description of the signal.
*/
description?: pulumi.Input<string>;
/**
* The name of the signal. Special characters and periods are not accepted.
*/
name?: pulumi.Input<string>;
/**
* The ID of the workspace.
*/
workspaceId: pulumi.Input<string>;
}