From 09612e993174092aec327686f013e8ee35af4a80 Mon Sep 17 00:00:00 2001 From: AWS PDK Automation Date: Mon, 4 Mar 2024 08:33:34 +0000 Subject: [PATCH] docs: publish from 54dc45056f6ab4cc3f679966dc3f42b0648d2523 --- api/java/type-safe-api/index.html | 359 ++++++++++++++++++++---- api/python/type-safe-api/index.html | 345 +++++++++++++++++++---- api/typescript/type-safe-api/index.html | 330 ++++++++++++++++++---- search/search_index.json | 2 +- sitemap.xml | 164 +++++------ sitemap.xml.gz | Bin 831 -> 831 bytes 6 files changed, 950 insertions(+), 250 deletions(-) diff --git a/api/java/type-safe-api/index.html b/api/java/type-safe-api/index.html index 94f830a8e..c89edaf0d 100644 --- a/api/java/type-safe-api/index.html +++ b/api/java/type-safe-api/index.html @@ -3880,6 +3880,13 @@ OperationDetails + + +
  • + + PartialManagedRuleGroupStatementProperty + +
  • @@ -25719,7 +25726,20 @@

    Initializer ManagedRule.builder() .name(java.lang.String) - .vendor(java.lang.String) +// .excludedRules(IResolvable) +// .excludedRules(java.util.List<IResolvable) +// .excludedRules(ExcludedRuleProperty>) +// .managedRuleGroupConfigs(IResolvable) +// .managedRuleGroupConfigs(java.util.List<IResolvable) +// .managedRuleGroupConfigs(ManagedRuleGroupConfigProperty>) +// .ruleActionOverrides(IResolvable) +// .ruleActionOverrides(java.util.List<IResolvable) +// .ruleActionOverrides(RuleActionOverrideProperty>) +// .scopeDownStatement(IResolvable) +// .scopeDownStatement(StatementProperty) +// .version(java.lang.String) +// .vendor(java.lang.String) +// .vendorName(java.lang.String) .build();

    Properties

    @@ -25738,10 +25758,40 @@

    Properties

    The name of the managed rule group. +excludedRules +software.amazon.awscdk.IResolvable OR java.util.List +Rules in the referenced rule group whose actions are set to Count . + + +managedRuleGroupConfigs +software.amazon.awscdk.IResolvable OR java.util.List +Additional information that's used by a managed rule group. + + +ruleActionOverrides +software.amazon.awscdk.IResolvable OR java.util.List +Action settings to use in the place of the rule actions that are configured inside the rule group. + + +scopeDownStatement +software.amazon.awscdk.IResolvable OR software.amazon.awscdk.services.wafv2.CfnWebACL.StatementProperty +An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. + + +version +java.lang.String +The version of the managed rule group to use. + + vendor java.lang.String The name of the managed rule group vendor. + +vendorName +java.lang.String +The name of the managed rule group vendor. +
    @@ -25754,7 +25804,64 @@
    nameRequired vendorRequired
    +
    excludedRulesOptional
    +
    public java.lang.Object getExcludedRules();
    +
    + +

    Rules in the referenced rule group whose actions are set to Count .

    +
    +

    Instead of this option, use RuleActionOverrides . It accepts any valid action setting, including Count .

    +
    +
    +
    managedRuleGroupConfigsOptional
    +
    public java.lang.Object getManagedRuleGroupConfigs();
    +
    + +

    Additional information that's used by a managed rule group.

    +

    Many managed rule groups don't require this. +The rule groups used for intelligent threat mitigation require additional configuration:

    + +
    +
    ruleActionOverridesOptional
    +
    public java.lang.Object getRuleActionOverrides();
    +
    + +

    Action settings to use in the place of the rule actions that are configured inside the rule group.

    +

    You specify one override for each rule whose action you want to change.

    +

    You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.

    +
    +
    scopeDownStatementOptional
    +
    public java.lang.Object getScopeDownStatement();
    +
    + +

    An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.

    +

    Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

    +
    +
    versionOptional
    +
    public java.lang.String getVersion();
    +
    + +

    The version of the managed rule group to use.

    +

    If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.

    +
    +
    ~~vendor~~Optional
    +
    public java.lang.String getVendor();