@aws-sdk/client-waf 3.32.0 → 3.36.0

package/dist-cjs/commands/UpdateWebACLCommand.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateWebACLCommand = void 0;
+const middleware_serde_1 = require("@aws-sdk/middleware-serde");
+const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
+/**
+ * <note>
+ *             <p>This is <b>AWS WAF Classic</b> documentation. For
+ *       more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
+ *       WAF Classic</a> in the developer guide.</p>
+ *             <p>
+ *                <b>For the latest version of AWS
+ *       WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p>
+ *          </note>
+ * 		       <p>Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies
+ * 			web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values:</p>
+ * 		       <ul>
+ *             <li>
+ *                <p>A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>.
+ * 				AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>The <code>Rules</code> that you want to add
+ *                or
+ *                delete. If you want to replace one <code>Rule</code> with another, you delete the
+ *                existing <code>Rule</code> and add the new one.</p>
+ *             </li>
+ *             <li>
+ *                <p>For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match
+ * 				the conditions in the <code>Rule</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>The order in which you want AWS WAF to evaluate the <code>Rules</code> in a
+ *                   <code>WebACL</code>. If you add more than one <code>Rule</code> to a
+ *                   <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code>
+ *                in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has
+ *                the lowest value for <code>Priority</code> is evaluated first.) When a web request
+ *                matches all
+ *                the
+ *                predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a
+ *                   <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or
+ *                block, and doesn't evaluate the request against the remaining <code>Rules</code> in
+ *                the <code>WebACL</code>, if any. </p>
+ *             </li>
+ *          </ul>
+ *
+ * 		       <p>To create and configure a <code>WebACL</code>, perform the following steps:</p>
+ * 		       <ol>
+ *             <li>
+ *                <p>Create and update the predicates that you want to include in <code>Rules</code>.
+ * 				For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>,
+ * 				<a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see
+ * 				<a>CreateRule</a> and <a>UpdateRule</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>Create a <code>WebACL</code>. See <a>CreateWebACL</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an
+ * 				<a>UpdateWebACL</a> request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code>
+ *                that you want to include in the <code>WebACL</code>, to specify the default action,
+ *                and to associate the <code>WebACL</code> with a CloudFront distribution. </p>
+ *                <p>The <code>ActivatedRule</code> can be a rule group. If you specify a rule group
+ *                as your
+ *                <code>ActivatedRule</code>
+ *                ,
+ *                you can exclude specific rules from that rule group.</p>
+ *                <p>If you already have a rule group associated with a web ACL and want to submit
+ *                an <code>UpdateWebACL</code> request to exclude certain rules from that rule group,
+ *                you must first remove the rule group from the web ACL, the re-insert it again,
+ *                specifying the excluded rules.
+ *                For details,
+ *                see
+ *                   <a>ActivatedRule$ExcludedRules</a>
+ *                .
+ *                </p>
+ *             </li>
+ *          </ol>
+ *          <p>Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the  <a>UpdateWebACL</a> request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. 		</p>
+ * 		       <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFClient, UpdateWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import
+ * // const { WAFClient, UpdateWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import
+ * const client = new WAFClient(config);
+ * const command = new UpdateWebACLCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateWebACLCommandInput} for command's `input` shape.
+ * @see {@link UpdateWebACLCommandOutput} for command's `response` shape.
+ * @see {@link WAFClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+class UpdateWebACLCommand extends smithy_client_1.Command {
+    // Start section: command_properties
+    // End section: command_properties
+    constructor(input) {
+        // Start section: command_constructor
+        super();
+        this.input = input;
+        // End section: command_constructor
+    }
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack, configuration, options) {
+        this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
+        const stack = clientStack.concat(this.middlewareStack);
+        const { logger } = configuration;
+        const clientName = "WAFClient";
+        const commandName = "UpdateWebACLCommand";
+        const handlerExecutionContext = {
+            logger,
+            clientName,
+            commandName,
+            inputFilterSensitiveLog: models_0_1.UpdateWebACLRequest.filterSensitiveLog,
+            outputFilterSensitiveLog: models_0_1.UpdateWebACLResponse.filterSensitiveLog,
+        };
+        const { requestHandler } = configuration;
+        return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
+    }
+    serialize(input, context) {
+        return Aws_json1_1_1.serializeAws_json1_1UpdateWebACLCommand(input, context);
+    }
+    deserialize(output, context) {
+        return Aws_json1_1_1.deserializeAws_json1_1UpdateWebACLCommand(output, context);
+    }
+}
+exports.UpdateWebACLCommand = UpdateWebACLCommand;

package/dist-cjs/commands/UpdateXssMatchSetCommand.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateXssMatchSetCommand = void 0;
+const middleware_serde_1 = require("@aws-sdk/middleware-serde");
+const smithy_client_1 = require("@aws-sdk/smithy-client");
+const models_0_1 = require("../models/models_0");
+const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
+/**
+ * <note>
+ *             <p>This is <b>AWS WAF Classic</b> documentation. For
+ *       more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
+ *       WAF Classic</a> in the developer guide.</p>
+ *             <p>
+ *                <b>For the latest version of AWS
+ *       WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p>
+ *          </note>
+ * 		       <p>Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>.
+ * 			For each <code>XssMatchTuple</code> object, you specify the following values:</p>
+ * 		       <ul>
+ *             <li>
+ *                <p>
+ *                   <code>Action</code>: Whether to insert the object into or delete the object from the
+ *                array. To change an
+ *                <code>XssMatchTuple</code>, you delete the existing object and add a new
+ *                one.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter,
+ * 				the name of the header or parameter.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before
+ * 				inspecting the request for cross-site scripting attacks.</p>
+ * 				           <p>You can only specify a single type of TextTransformation.</p>
+ *             </li>
+ *          </ul>
+ * 		       <p>You use <code>XssMatchSet</code> objects to specify which CloudFront requests
+ *          that
+ *          you want to allow, block, or count. For example, if you're receiving
+ *          requests that contain cross-site scripting attacks in the request body and you want to
+ *          block the requests, you can create an <code>XssMatchSet</code> with the applicable
+ *          settings, and then configure AWS WAF to block the requests. </p>
+ * 		       <p>To create and configure an <code>XssMatchSet</code>, perform the following steps:</p>
+ * 		       <ol>
+ *             <li>
+ *                <p>Submit a <a>CreateXssMatchSet</a> request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an
+ * 				<a>UpdateIPSet</a> request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to
+ * 				inspect for cross-site scripting attacks.</p>
+ *             </li>
+ *          </ol>
+ * 		       <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the
+ * 			<a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFClient, UpdateXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import
+ * // const { WAFClient, UpdateXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import
+ * const client = new WAFClient(config);
+ * const command = new UpdateXssMatchSetCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateXssMatchSetCommandInput} for command's `input` shape.
+ * @see {@link UpdateXssMatchSetCommandOutput} for command's `response` shape.
+ * @see {@link WAFClientResolvedConfig | config} for command's `input` shape.
+ *
+ */
+class UpdateXssMatchSetCommand extends smithy_client_1.Command {
+    // Start section: command_properties
+    // End section: command_properties
+    constructor(input) {
+        // Start section: command_constructor
+        super();
+        this.input = input;
+        // End section: command_constructor
+    }
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack, configuration, options) {
+        this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
+        const stack = clientStack.concat(this.middlewareStack);
+        const { logger } = configuration;
+        const clientName = "WAFClient";
+        const commandName = "UpdateXssMatchSetCommand";
+        const handlerExecutionContext = {
+            logger,
+            clientName,
+            commandName,
+            inputFilterSensitiveLog: models_0_1.UpdateXssMatchSetRequest.filterSensitiveLog,
+            outputFilterSensitiveLog: models_0_1.UpdateXssMatchSetResponse.filterSensitiveLog,
+        };
+        const { requestHandler } = configuration;
+        return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
+    }
+    serialize(input, context) {
+        return Aws_json1_1_1.serializeAws_json1_1UpdateXssMatchSetCommand(input, context);
+    }
+    deserialize(output, context) {
+        return Aws_json1_1_1.deserializeAws_json1_1UpdateXssMatchSetCommand(output, context);
+    }
+}
+exports.UpdateXssMatchSetCommand = UpdateXssMatchSetCommand;

package/dist-cjs/endpoints.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRegionInfoProvider = void 0;
+const config_resolver_1 = require("@aws-sdk/config-resolver");
+const regionHash = {
+    "aws-fips": {
+        hostname: "waf-fips.amazonaws.com",
+        signingRegion: "us-east-1",
+    },
+    "aws-global": {
+        hostname: "waf.amazonaws.com",
+        signingRegion: "us-east-1",
+    },
+};
+const partitionHash = {
+    aws: {
+        regions: [
+            "af-south-1",
+            "ap-east-1",
+            "ap-northeast-1",
+            "ap-northeast-2",
+            "ap-northeast-3",
+            "ap-south-1",
+            "ap-southeast-1",
+            "ap-southeast-2",
+            "aws-fips",
+            "aws-global",
+            "ca-central-1",
+            "eu-central-1",
+            "eu-north-1",
+            "eu-south-1",
+            "eu-west-1",
+            "eu-west-2",
+            "eu-west-3",
+            "me-south-1",
+            "sa-east-1",
+            "us-east-1",
+            "us-east-2",
+            "us-west-1",
+            "us-west-2",
+        ],
+        endpoint: "aws-global",
+    },
+    "aws-cn": {
+        regions: ["cn-north-1", "cn-northwest-1"],
+        hostname: "waf.{region}.amazonaws.com.cn",
+    },
+    "aws-iso": {
+        regions: ["us-iso-east-1"],
+        hostname: "waf.{region}.c2s.ic.gov",
+    },
+    "aws-iso-b": {
+        regions: ["us-isob-east-1"],
+        hostname: "waf.{region}.sc2s.sgov.gov",
+    },
+    "aws-us-gov": {
+        regions: ["us-gov-east-1", "us-gov-west-1"],
+        hostname: "waf.{region}.amazonaws.com",
+    },
+};
+const defaultRegionInfoProvider = async (region, options) => config_resolver_1.getRegionInfo(region, {
+    ...options,
+    signingService: "waf",
+    regionHash,
+    partitionHash,
+});
+exports.defaultRegionInfoProvider = defaultRegionInfoProvider;

package/dist-cjs/index.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./WAFClient"), exports);
+tslib_1.__exportStar(require("./WAF"), exports);
+tslib_1.__exportStar(require("./commands/CreateByteMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateGeoMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateIPSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateRateBasedRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateRegexMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateRegexPatternSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateRuleGroupCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateSizeConstraintSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateSqlInjectionMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateWebACLCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateWebACLMigrationStackCommand"), exports);
+tslib_1.__exportStar(require("./commands/CreateXssMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteByteMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteGeoMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteIPSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteLoggingConfigurationCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeletePermissionPolicyCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteRateBasedRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteRegexMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteRegexPatternSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteRuleGroupCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteSizeConstraintSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteSqlInjectionMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteWebACLCommand"), exports);
+tslib_1.__exportStar(require("./commands/DeleteXssMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetByteMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetChangeTokenCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetChangeTokenStatusCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetGeoMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetIPSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetLoggingConfigurationCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetPermissionPolicyCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRateBasedRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRateBasedRuleManagedKeysCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRegexMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRegexPatternSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetRuleGroupCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetSampledRequestsCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetSizeConstraintSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetSqlInjectionMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetWebACLCommand"), exports);
+tslib_1.__exportStar(require("./commands/GetXssMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListActivatedRulesInRuleGroupCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListByteMatchSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListGeoMatchSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListIPSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListLoggingConfigurationsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListRateBasedRulesCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListRegexMatchSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListRegexPatternSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListRuleGroupsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListRulesCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListSizeConstraintSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListSqlInjectionMatchSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListSubscribedRuleGroupsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListTagsForResourceCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListWebACLsCommand"), exports);
+tslib_1.__exportStar(require("./commands/ListXssMatchSetsCommand"), exports);
+tslib_1.__exportStar(require("./commands/PutLoggingConfigurationCommand"), exports);
+tslib_1.__exportStar(require("./commands/PutPermissionPolicyCommand"), exports);
+tslib_1.__exportStar(require("./commands/TagResourceCommand"), exports);
+tslib_1.__exportStar(require("./commands/UntagResourceCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateByteMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateGeoMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateIPSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateRateBasedRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateRegexMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateRegexPatternSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateRuleCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateRuleGroupCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateSizeConstraintSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateSqlInjectionMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateWebACLCommand"), exports);
+tslib_1.__exportStar(require("./commands/UpdateXssMatchSetCommand"), exports);
+tslib_1.__exportStar(require("./models/index"), exports);

package/dist-cjs/models/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./models_0"), exports);