Package software.amazon.awscdk.services.waf

Interface CfnWebACL.ActivatedRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.ActivatedRuleProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.ActivatedRuleProperty
extends software.amazon.jsii.JsiiSerializable

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL , and the action that you want AWS WAF to take when a web request matches the Rule ( ALLOW , BLOCK , or COUNT ).

To specify whether to insert or delete a Rule , use the Action parameter in the WebACLUpdate data type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.waf.*;
 ActivatedRuleProperty activatedRuleProperty = ActivatedRuleProperty.builder()
         .priority(123)
         .ruleId("ruleId")
         // the properties below are optional
         .action(WafActionProperty.builder()
                 .type("type")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-activatedrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACL.ActivatedRuleProperty.Builder	A builder for CfnWebACL.ActivatedRuleProperty
static final class	CfnWebACL.ActivatedRuleProperty.Jsii$Proxy	An implementation for CfnWebACL.ActivatedRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.ActivatedRuleProperty.Builder	builder()
default Object	getAction()	Specifies the action that Amazon CloudFront or AWS WAF takes when a web request matches the conditions in the Rule .
Number	getPriority()	Specifies the order in which the Rules in a WebACL are evaluated.
String	getRuleId()	The RuleId for a Rule .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

Specifies the order in which the Rules in a WebACL are evaluated.

Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL , the values don't need to be consecutive.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-activatedrule.html#cfn-waf-webacl-activatedrule-priority

getRuleId

@Stability(Stable)
@NotNull
String getRuleId()

The RuleId for a Rule .

You use RuleId to get more information about a Rule , update a Rule , insert a Rule into a WebACL or delete a one from a WebACL , or delete a Rule from AWS WAF .

RuleId is returned by CreateRule and by ListRules .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-activatedrule.html#cfn-waf-webacl-activatedrule-ruleid

getAction

@Stability(Stable)
@Nullable
default Object getAction()

Specifies the action that Amazon CloudFront or AWS WAF takes when a web request matches the conditions in the Rule .

Valid values for Action include the following:

• ALLOW : CloudFront responds with the requested object.
• BLOCK : CloudFront responds with an HTTP 403 (Forbidden) status code.
• COUNT : AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL . In this case, you do not use ActivatedRule|Action . For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-webacl-activatedrule.html#cfn-waf-webacl-activatedrule-action

builder

@Stability(Stable)
static CfnWebACL.ActivatedRuleProperty.Builder builder()

Returns:

a CfnWebACL.ActivatedRuleProperty.Builder of CfnWebACL.ActivatedRuleProperty