interface ManagedRuleGroupConfigProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.WAFv2.CfnWebACL.ManagedRuleGroupConfigProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnWebACL_ManagedRuleGroupConfigProperty |
![]() | software.amazon.awscdk.services.wafv2.CfnWebACL.ManagedRuleGroupConfigProperty |
![]() | aws_cdk.aws_wafv2.CfnWebACL.ManagedRuleGroupConfigProperty |
![]() | aws-cdk-lib » aws_wafv2 » CfnWebACL » ManagedRuleGroupConfigProperty |
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
- Use the
AWSManagedRulesACFPRuleSet
configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields. - Use the
AWSManagedRulesATPRuleSet
configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. - Use the
AWSManagedRulesBotControlRuleSet
configuration object to configure the protection level that you want the Bot Control rule group to use.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';
const managedRuleGroupConfigProperty: wafv2.CfnWebACL.ManagedRuleGroupConfigProperty = {
awsManagedRulesAcfpRuleSet: {
creationPath: 'creationPath',
registrationPagePath: 'registrationPagePath',
requestInspection: {
payloadType: 'payloadType',
// the properties below are optional
addressFields: [{
identifier: 'identifier',
}],
emailField: {
identifier: 'identifier',
},
passwordField: {
identifier: 'identifier',
},
phoneNumberFields: [{
identifier: 'identifier',
}],
usernameField: {
identifier: 'identifier',
},
},
// the properties below are optional
enableRegexInPath: false,
responseInspection: {
bodyContains: {
failureStrings: ['failureStrings'],
successStrings: ['successStrings'],
},
header: {
failureValues: ['failureValues'],
name: 'name',
successValues: ['successValues'],
},
json: {
failureValues: ['failureValues'],
identifier: 'identifier',
successValues: ['successValues'],
},
statusCode: {
failureCodes: [123],
successCodes: [123],
},
},
},
awsManagedRulesAtpRuleSet: {
loginPath: 'loginPath',
// the properties below are optional
enableRegexInPath: false,
requestInspection: {
passwordField: {
identifier: 'identifier',
},
payloadType: 'payloadType',
usernameField: {
identifier: 'identifier',
},
},
responseInspection: {
bodyContains: {
failureStrings: ['failureStrings'],
successStrings: ['successStrings'],
},
header: {
failureValues: ['failureValues'],
name: 'name',
successValues: ['successValues'],
},
json: {
failureValues: ['failureValues'],
identifier: 'identifier',
successValues: ['successValues'],
},
statusCode: {
failureCodes: [123],
successCodes: [123],
},
},
},
awsManagedRulesBotControlRuleSet: {
inspectionLevel: 'inspectionLevel',
// the properties below are optional
enableMachineLearning: false,
},
loginPath: 'loginPath',
passwordField: {
identifier: 'identifier',
},
payloadType: 'payloadType',
usernameField: {
identifier: 'identifier',
},
};
Properties
Name | Type | Description |
---|---|---|
aws | IResolvable | AWSManaged | Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet . |
aws | IResolvable | AWSManaged | Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet . |
aws | IResolvable | AWSManaged | Additional configuration for using the Bot Control managed rule group. |
login | string | > Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet . |
password | IResolvable | Field | > Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet . |
payload | string | > Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet . |
username | IResolvable | Field | > Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet . |
awsManagedRulesAcfpRuleSet?
Type:
IResolvable
|
AWSManaged
(optional)
Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet
.
Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.
For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide .
awsManagedRulesAtpRuleSet?
Type:
IResolvable
|
AWSManaged
(optional)
Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet
.
Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.
This configuration replaces the individual configuration fields in ManagedRuleGroupConfig
and provides additional feature configuration.
For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .
awsManagedRulesBotControlRuleSet?
Type:
IResolvable
|
AWSManaged
(optional)
Additional configuration for using the Bot Control managed rule group.
Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .
loginPath?
Type:
string
(optional)
Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
.
passwordField?
Type:
IResolvable
|
Field
(optional)
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
payloadType?
Type:
string
(optional)
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
usernameField?
Type:
IResolvable
|
Field
(optional)
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.