1.204.0

interface CustomResponseProperty

LanguageType name
.NETAmazon.CDK.AWS.WAFv2.CfnWebACL.CustomResponseProperty
Javasoftware.amazon.awscdk.services.wafv2.CfnWebACL.CustomResponseProperty
Pythonaws_cdk.aws_wafv2.CfnWebACL.CustomResponseProperty
TypeScript @aws-cdk/aws-wafv2 » CfnWebACL » CustomResponseProperty

A custom response to send to the client.

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as wafv2 from '@aws-cdk/aws-wafv2';
const customResponseProperty: wafv2.CfnWebACL.CustomResponseProperty = {
  responseCode: 123,

  // the properties below are optional
  customResponseBodyKey: 'customResponseBodyKey',
  responseHeaders: [{
    name: 'name',
    value: 'value',
  }],
};

Properties

NameTypeDescription
responseCodenumberThe HTTP status code to return to the client.
customResponseBodyKey?stringReferences the response body that you want AWS WAF to return to the web request client.
responseHeaders?IResolvable | IResolvable | CustomHTTPHeaderProperty[]The HTTP headers to use in the response. Duplicate header names are not allowed.

responseCode

Type: number

The HTTP status code to return to the client.

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 .

customResponseBodyKey?

Type: string (optional)

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

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.

responseHeaders?

Type: IResolvable | IResolvable | CustomHTTPHeaderProperty[] (optional)

The HTTP headers to use in the response. 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 .

← PreviousNext →