Package software.amazon.awscdk.services.wafv2

Class CfnWebACL.RuleProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.wafv2.CfnWebACL.RuleProperty.Jsii$Proxy

All Implemented Interfaces:

CfnWebACL.RuleProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnWebACL.RuleProperty

@Stability(Stable)
@Internal
public static final class CfnWebACL.RuleProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnWebACL.RuleProperty

An implementation for CfnWebACL.RuleProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.wafv2.CfnWebACL.RuleProperty

CfnWebACL.RuleProperty.Builder, CfnWebACL.RuleProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnWebACL.RuleProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnWebACL.RuleProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAction()	The action that AWS WAF should take on a web request when it matches the rule's statement.
final Object	getCaptchaConfig()	Specifies how AWS WAF should handle CAPTCHA evaluations.
final Object	getChallengeConfig()	Specifies how AWS WAF should handle Challenge evaluations.
final String	getName()	The name of the rule.
final Object	getOverrideAction()	The override action to apply to the rules in a rule group, instead of the individual rule action settings.
final Number	getPriority()	If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority .
final Object	getRuleLabels()	Labels to apply to web requests that match the rule match statement.
final Object	getStatement()	The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
final Object	getVisibilityConfig()	Defines and enables Amazon CloudWatch metrics and web request sample collection.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnWebACL.RuleProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnWebACL.RuleProperty.Builder.

Method Details

getName

public final String getName()

Description copied from interface: CfnWebACL.RuleProperty

The name of the rule.

If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name.

Specified by:

getName in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-name

getPriority

public final Number getPriority()

Description copied from interface: CfnWebACL.RuleProperty

If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority .

AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

Specified by:

getPriority in interface CfnWebACL.RuleProperty

See Also:

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

getStatement

public final Object getStatement()

Description copied from interface: CfnWebACL.RuleProperty

The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

Specified by:

getStatement in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-statement

getVisibilityConfig

public final Object getVisibilityConfig()

Description copied from interface: CfnWebACL.RuleProperty

Defines and enables Amazon CloudWatch metrics and web request sample collection.

If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.

Specified by:

getVisibilityConfig in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-visibilityconfig

getAction

public final Object getAction()

Description copied from interface: CfnWebACL.RuleProperty

The action that AWS WAF should take on a web request when it matches the rule's statement.

Settings at the web ACL level can override the rule action setting.

This is used only for rules whose statements don't reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement .

You must set either this Action setting or the rule's OverrideAction , but not both:

• If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting.
• If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group.

Specified by:

getAction in interface CfnWebACL.RuleProperty

See Also:

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

getCaptchaConfig

public final Object getCaptchaConfig()

Description copied from interface: CfnWebACL.RuleProperty

Specifies how AWS WAF should handle CAPTCHA evaluations.

If you don't specify this, AWS WAF uses the CAPTCHA configuration that's defined for the web ACL.

Specified by:

getCaptchaConfig in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-captchaconfig

getChallengeConfig

public final Object getChallengeConfig()

Description copied from interface: CfnWebACL.RuleProperty

Specifies how AWS WAF should handle Challenge evaluations.

If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.

Specified by:

getChallengeConfig in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-challengeconfig

getOverrideAction

public final Object getOverrideAction()

Description copied from interface: CfnWebACL.RuleProperty

The override action to apply to the rules in a rule group, instead of the individual rule action settings.

This is used only for rules whose statements reference a rule group. Rule statements that reference a rule group are RuleGroupReferenceStatement and ManagedRuleGroupStatement .

Set the override action to none to leave the rule group rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

You must set either this OverrideAction setting or the Action setting, but not both:

• If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting.
• If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting.

Specified by:

getOverrideAction in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-overrideaction

getRuleLabels

public final Object getRuleLabels()

Description copied from interface: CfnWebACL.RuleProperty

Labels to apply to web requests that match the rule match statement.

AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

• Separate each component of the label with a colon.
• Each namespace or name can have up to 128 characters.
• You can specify up to 5 namespaces in a label.
• Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

Specified by:

getRuleLabels in interface CfnWebACL.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html#cfn-wafv2-webacl-rule-rulelabels

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object