class CfnRulePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.WAF.Mixins.CfnRulePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswaf/mixins#CfnRulePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.waf.mixins.CfnRulePropsMixin
Python	aws_cdk.mixins_preview.aws_waf.mixins.CfnRulePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_waf » mixins » CfnRulePropsMixin

Implements IMixin

Extends Mixin

This is AWS WAF Classic documentation.

For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet , IPSet , and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

• An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
• A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot .

To match the settings in this Rule , a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-rule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as waf_mixins } from '@aws-cdk/mixins-preview/aws-waf';
const cfnRulePropsMixin = new waf_mixins.CfnRulePropsMixin({
  metricName: 'metricName',
  name: 'name',
  predicates: [{
    dataId: 'dataId',
    negated: false,
    type: 'type',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRulePropsMixin(props: CfnRuleMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnRuleMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::WAF::Rule.

Properties

Name	Type	Description
props	CfnRuleMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnRuleMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.