@pulumi/fastly
Version:
A Pulumi package for creating and managing fastly cloud resources.. Based on terraform-provider-fastly: version v4
138 lines (137 loc) • 4.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Fastly Next-Gen WAF **List** resource scoped to a specific **workspace**.
*
* Workspace-scoped lists are local to a workspace and typically used within workspace-specific rules.
*
* ## 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: "Workspace with custom list",
* mode: "block",
* ipAnonymization: "hashed",
* clientIpHeaders: [
* "X-Forwarded-For",
* "X-Real-IP",
* ],
* defaultBlockingResponseCode: 403,
* attackSignalThresholds: {
* oneMinute: 100,
* tenMinutes: 500,
* oneHour: 1000,
* immediate: true,
* },
* });
* const exampleNgwafWorkspaceList = new fastly.NgwafWorkspaceList("example", {
* workspaceId: example.id,
* name: "local-allowlist",
* description: "IP allowlist for this workspace",
* type: "ip",
* entries: [
* "192.168.0.1",
* "10.0.0.1",
* ],
* });
* ```
*
* ## Import
*
* Fastly Next-Gen WAF workspace-scoped lists can be imported using the format `<workspaceID>/<listID>`, e.g.:
*
* ```sh
* $ pulumi import fastly:index/ngwafWorkspaceList:NgwafWorkspaceList demo <workspaceID>/<listID>
* ```
*/
export declare class NgwafWorkspaceList extends pulumi.CustomResource {
/**
* Get an existing NgwafWorkspaceList 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?: NgwafWorkspaceListState, opts?: pulumi.CustomResourceOptions): NgwafWorkspaceList;
/**
* Returns true if the given object is an instance of NgwafWorkspaceList. 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 NgwafWorkspaceList;
/**
* The description of the list.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The values in the list.
*/
readonly entries: pulumi.Output<string[]>;
/**
* The name of the list.
*/
readonly name: pulumi.Output<string>;
/**
* The type of list. Accepted values are `string`, `wildcard`, `ip`, `country`, and `signal`.
*/
readonly type: pulumi.Output<string>;
readonly workspaceId: pulumi.Output<string>;
/**
* Create a NgwafWorkspaceList 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: NgwafWorkspaceListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NgwafWorkspaceList resources.
*/
export interface NgwafWorkspaceListState {
/**
* The description of the list.
*/
description?: pulumi.Input<string>;
/**
* The values in the list.
*/
entries?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the list.
*/
name?: pulumi.Input<string>;
/**
* The type of list. Accepted values are `string`, `wildcard`, `ip`, `country`, and `signal`.
*/
type?: pulumi.Input<string>;
workspaceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NgwafWorkspaceList resource.
*/
export interface NgwafWorkspaceListArgs {
/**
* The description of the list.
*/
description?: pulumi.Input<string>;
/**
* The values in the list.
*/
entries: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the list.
*/
name?: pulumi.Input<string>;
/**
* The type of list. Accepted values are `string`, `wildcard`, `ip`, `country`, and `signal`.
*/
type: pulumi.Input<string>;
workspaceId: pulumi.Input<string>;
}