Class CfnWebACL.RuleActionProperty
The action that AWS WAF should take on a web request when it matches a rule's statement.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class RuleActionProperty : Object, CfnWebACL.IRuleActionProperty
Syntax (vb)
Public Class RuleActionProperty
Inherits Object
Implements CfnWebACL.IRuleActionProperty
Remarks
Settings at the web ACL level can override the rule action setting.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;
var ruleActionProperty = new RuleActionProperty {
Allow = new AllowActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Block = new BlockActionProperty {
CustomResponse = new CustomResponseProperty {
ResponseCode = 123,
// the properties below are optional
CustomResponseBodyKey = "customResponseBodyKey",
ResponseHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Captcha = new CaptchaActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Challenge = new ChallengeActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
},
Count = new CountActionProperty {
CustomRequestHandling = new CustomRequestHandlingProperty {
InsertHeaders = new [] { new CustomHTTPHeaderProperty {
Name = "name",
Value = "value"
} }
}
}
};
Synopsis
Constructors
RuleActionProperty() |
Properties
Allow | Instructs AWS WAF to allow the web request. |
Block | Instructs AWS WAF to block the web request. |
Captcha | Specifies that AWS WAF should run a |
Challenge | Instructs AWS WAF to run a |
Count | Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL. |
Constructors
RuleActionProperty()
public RuleActionProperty()
Properties
Allow
Instructs AWS WAF to allow the web request.
public object Allow { get; set; }
Property Value
System.Object
Remarks
Block
Instructs AWS WAF to block the web request.
public object Block { get; set; }
Property Value
System.Object
Remarks
Captcha
Specifies that AWS WAF should run a CAPTCHA
check against the request:.
public object Captcha { get; set; }
Property Value
System.Object
Remarks
AWS WAF generates a response that it sends back to the client, which includes the following:
You can configure the expiration time in the CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
Challenge
Instructs AWS WAF to run a Challenge
check against the web request.
public object Challenge { get; set; }
Property Value
System.Object
Remarks
Count
Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
public object Count { get; set; }
Property Value
System.Object