Class CfnRuleGroup.CustomResponseProperty

A custom response to send to the client.

Inheritance

object

CfnRuleGroup.CustomResponseProperty

Implements

CfnRuleGroup.ICustomResponseProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRuleGroup.CustomResponseProperty : CfnRuleGroup.ICustomResponseProperty

Syntax (vb)

Public Class CfnRuleGroup.CustomResponseProperty Implements CfnRuleGroup.ICustomResponseProperty

Remarks

You can define a custom response for rule actions and default web ACL actions that are set to Block .

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html

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 customResponseProperty = new CustomResponseProperty {
                 ResponseCode = 123,

                 // the properties below are optional
                 CustomResponseBodyKey = "customResponseBodyKey",
                 ResponseHeaders = new [] { new CustomHTTPHeaderProperty {
                     Name = "name",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CustomResponseProperty()

A custom response to send to the client.

Properties

CustomResponseBodyKey	References the response body that you want AWS WAF to return to the web request client.
ResponseCode	The HTTP status code to return to the client.
ResponseHeaders	The HTTP headers to use in the response.

Constructors

CustomResponseProperty()

A custom response to send to the client.

public CustomResponseProperty()

Remarks

You can define a custom response for rule actions and default web ACL actions that are set to Block .

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html

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 customResponseProperty = new CustomResponseProperty {
                 ResponseCode = 123,

                 // the properties below are optional
                 CustomResponseBodyKey = "customResponseBodyKey",
                 ResponseHeaders = new [] { new CustomHTTPHeaderProperty {
                     Name = "name",
                     Value = "value"
                 } }
             };

Properties

CustomResponseBodyKey

References the response body that you want AWS WAF to return to the web request client.

public string? CustomResponseBodyKey { get; set; }

Property Value

string

Remarks

You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-customresponsebodykey

ResponseCode

The HTTP status code to return to the client.

public double ResponseCode { get; set; }

Property Value

double

Remarks

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-responsecode

ResponseHeaders

The HTTP headers to use in the response.

public object? ResponseHeaders { get; set; }

Property Value

object

Remarks

You can specify any header name except for content-type . Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html#cfn-wafv2-rulegroup-customresponse-responseheaders

Implements

CfnRuleGroup.ICustomResponseProperty