@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
170 lines • 5.73 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.WebAcl = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a WAF Regional Web ACL Resource for use with Application Load Balancer.
*
* ## Example Usage
*
* ### Regular Rule
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const ipset = new aws.wafregional.IpSet("ipset", {
* name: "tfIPSet",
* ipSetDescriptors: [{
* type: "IPV4",
* value: "192.0.7.0/24",
* }],
* });
* const wafrule = new aws.wafregional.Rule("wafrule", {
* name: "tfWAFRule",
* metricName: "tfWAFRule",
* predicates: [{
* dataId: ipset.id,
* negated: false,
* type: "IPMatch",
* }],
* });
* const wafacl = new aws.wafregional.WebAcl("wafacl", {
* name: "tfWebACL",
* metricName: "tfWebACL",
* defaultAction: {
* type: "ALLOW",
* },
* rules: [{
* action: {
* type: "BLOCK",
* },
* priority: 1,
* ruleId: wafrule.id,
* type: "REGULAR",
* }],
* });
* ```
*
* ### Group Rule
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.wafregional.WebAcl("example", {
* name: "example",
* metricName: "example",
* defaultAction: {
* type: "ALLOW",
* },
* rules: [{
* priority: 1,
* ruleId: exampleAwsWafregionalRuleGroup.id,
* type: "GROUP",
* overrideAction: {
* type: "NONE",
* },
* }],
* });
* ```
*
* ### Logging
*
* > *NOTE:* The Kinesis Firehose Delivery Stream name must begin with `aws-waf-logs-`. See the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) for more information about enabling WAF logging.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.wafregional.WebAcl("example", {loggingConfiguration: {
* logDestination: exampleAwsKinesisFirehoseDeliveryStream.arn,
* redactedFields: {
* fieldToMatches: [
* {
* type: "URI",
* },
* {
* data: "referer",
* type: "HEADER",
* },
* ],
* },
* }});
* ```
*
* ## Import
*
* Using `pulumi import`, import WAF Regional Web ACL using the id. For example:
*
* ```sh
* $ pulumi import aws:wafregional/webAcl:WebAcl wafacl a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
* ```
*/
class WebAcl extends pulumi.CustomResource {
/**
* Get an existing WebAcl 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 WebAcl(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of WebAcl. 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'] === WebAcl.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["defaultAction"] = state?.defaultAction;
resourceInputs["loggingConfiguration"] = state?.loggingConfiguration;
resourceInputs["metricName"] = state?.metricName;
resourceInputs["name"] = state?.name;
resourceInputs["region"] = state?.region;
resourceInputs["rules"] = state?.rules;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.defaultAction === undefined && !opts.urn) {
throw new Error("Missing required property 'defaultAction'");
}
if (args?.metricName === undefined && !opts.urn) {
throw new Error("Missing required property 'metricName'");
}
resourceInputs["defaultAction"] = args?.defaultAction;
resourceInputs["loggingConfiguration"] = args?.loggingConfiguration;
resourceInputs["metricName"] = args?.metricName;
resourceInputs["name"] = args?.name;
resourceInputs["region"] = args?.region;
resourceInputs["rules"] = args?.rules;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(WebAcl.__pulumiType, name, resourceInputs, opts);
}
}
exports.WebAcl = WebAcl;
/** @internal */
WebAcl.__pulumiType = 'aws:wafregional/webAcl:WebAcl';
//# sourceMappingURL=webAcl.js.map