@@ -33511,7 +33758,7 @@
+Properties
diff --git a/api/python/type-safe-api/index.html b/api/python/type-safe-api/index.html
index 777649d46..ff68d02ac 100644
--- a/api/python/type-safe-api/index.html
+++ b/api/python/type-safe-api/index.html
@@ -3880,6 +3880,13 @@
OperationDetails
+
+
+
+
+ PartialManagedRuleGroupStatementProperty
+
+
@@ -27500,7 +27507,13 @@
+excluded_rules |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ExcludedRuleProperty]]] |
+Rules in the referenced rule group whose actions are set to Count . |
+
+
+managed_rule_group_configs |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ManagedRuleGroupConfigProperty]]] |
+Additional information that's used by a managed rule group. |
+
+
+rule_action_overrides |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.RuleActionOverrideProperty]]] |
+Action settings to use in the place of the rule actions that are configured inside the rule group. |
+
+
+scope_down_statement |
+typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.StatementProperty] |
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. |
+
+
+version |
+str |
+The version of the managed rule group to use. |
+
+
vendor |
str |
The name of the managed rule group vendor. |
+
+vendor_name |
+str |
+The name of the managed rule group vendor. |
+
@@ -27535,7 +27578,64 @@ name
Required vendor
Required
+excluded_rules
Optional
+excluded_rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ExcludedRuleProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ExcludedRuleProperty]]]
+
+Rules in the referenced rule group whose actions are set to Count
.
+
+Instead of this option, use RuleActionOverrides
. It accepts any valid action setting, including Count
.
+
+
+managed_rule_group_configs
Optional
+managed_rule_group_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ManagedRuleGroupConfigProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.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.
+
+
+rule_action_overrides
Optional
+rule_action_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleActionOverrideProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.RuleActionOverrideProperty]]]
+
+Action settings to use in the place of the rule actions that are configured inside the rule group.
+You specify one override for each rule whose action you want to change.
+You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
+
+scope_down_statement
Optional
+scope_down_statement: typing.Union[IResolvable, StatementProperty]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.StatementProperty]
+
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
+Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
+
+version
Optional
+
+
+The version of the managed rule group to use.
+If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
+
+~~vendor
~~Optional
+
+- Deprecated: use the
vendorName
property instead. This property will be removed in the next major release.
+
@@ -27544,6 +27644,19 @@ vendor
Required The name of the managed rule group vendor.
You use this, along with the rule group name, to identify the rule group.
+vendor_name
Optional
+
+
+The name of the managed rule group vendor.
+You use this, along with the rule group name, to identify a rule group.
+Preferred to the property vendor
+
+http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-vendorname
+
+
MethodAndPath
Structure to contain an API operation's method and path.
Initializer
@@ -27989,7 +28102,7 @@ use_docker
Optional OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally
-version
Optional
+version
Optional
@@ -28142,9 +28255,129 @@ content_types
Optional <
Content types accepted by this operation.
+PartialManagedRuleGroupStatementProperty
+PartialManagedRuleGroupStatementProperty.
+Initializer
+import aws.pdk.type_safe_api
+
+aws.pdk.type_safe_api.PartialManagedRuleGroupStatementProperty(
+ name: str,
+ excluded_rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ExcludedRuleProperty]]] = None,
+ managed_rule_group_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ManagedRuleGroupConfigProperty]]] = None,
+ rule_action_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleActionOverrideProperty]]] = None,
+ scope_down_statement: typing.Union[IResolvable, StatementProperty] = None,
+ version: str = None
+)
+
+Properties
+
+
+
+Name |
+Type |
+Description |
+
+
+
+
+name |
+str |
+The name of the managed rule group. |
+
+
+excluded_rules |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ExcludedRuleProperty]]] |
+Rules in the referenced rule group whose actions are set to Count . |
+
+
+managed_rule_group_configs |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ManagedRuleGroupConfigProperty]]] |
+Additional information that's used by a managed rule group. |
+
+
+rule_action_overrides |
+typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.RuleActionOverrideProperty]]] |
+Action settings to use in the place of the rule actions that are configured inside the rule group. |
+
+
+scope_down_statement |
+typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.StatementProperty] |
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. |
+
+
+version |
+str |
+The version of the managed rule group to use. |
+
+
+
+
+name
Required
+
+
+The name of the managed rule group.
+You use this, along with the vendor name, to identify the rule group.
+
+excluded_rules
Optional
+excluded_rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ExcludedRuleProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.ExcludedRuleProperty]]]
+
+Rules in the referenced rule group whose actions are set to Count
.
+
+Instead of this option, use RuleActionOverrides
. It accepts any valid action setting, including Count
.
+
+
+managed_rule_group_configs
Optional
+managed_rule_group_configs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ManagedRuleGroupConfigProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.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.
+
+
+rule_action_overrides
Optional
+rule_action_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RuleActionOverrideProperty]]]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, typing.List[typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.RuleActionOverrideProperty]]]
+
+Action settings to use in the place of the rule actions that are configured inside the rule group.
+You specify one override for each rule whose action you want to change.
+You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
+
+scope_down_statement
Optional
+scope_down_statement: typing.Union[IResolvable, StatementProperty]
+
+
+- Type: typing.Union[aws_cdk.IResolvable, aws_cdk.aws_wafv2.CfnWebACL.StatementProperty]
+
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
+Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
+
+version
Optional
+
+
+The version of the managed rule group to use.
+If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
+
ProjectCollections
Collections of projects managed by type-safe-api.
-Initializer
+Initializer
-Properties
+Properties
@@ -28263,7 +28496,7 @@ runtimes
Required PythonProjectOptions
PythonProjectOptions.
-Initializer
+Initializer
import aws.pdk.type_safe_api
aws.pdk.type_safe_api.PythonProjectOptions(
@@ -28317,7 +28550,7 @@ Initializer vscode: bool = None
)
-Properties
+Properties
@@ -29002,7 +29235,7 @@ stale_options
Optional
Auto-close stale issues and pull requests.
To disable set stale
to false
.
-version
Optional
+version
Optional
@@ -29023,7 +29256,7 @@ vscode
Optional RuntimeConfiguration
Configuration for generated runtime projects.
-Initializer
+Initializer
-Properties
+Properties
@@ -29075,7 +29308,7 @@ options
Optional S3IntegrationProps
Options for S3Integration.
-Initializer
+Initializer
import aws.pdk.type_safe_api
aws.pdk.type_safe_api.S3IntegrationProps(
@@ -29085,7 +29318,7 @@ Initializer path: str = None
)
-Properties
+Properties
@@ -29155,7 +29388,7 @@ path
Optional SerializedCorsOptions
Cross-origin resource sharing options.
-Initializer
+Initializer
-Properties
+Properties
@@ -29232,7 +29465,7 @@ status_code
Required
SmithyBuildOptions
Options for the smithy build files.
-Initializer
+Initializer
-Properties
+Properties
@@ -29345,7 +29578,7 @@ projections
Optional
SmithyCommon
Properties common to smithy plugins and the root smithy build.
-Initializer
+Initializer
-Properties
+Properties
@@ -29394,7 +29627,7 @@ plugins
Optional SmithyDefinitionOptions
Options for a smithy build project.
-Initializer
+Initializer
-Properties
+Properties
@@ -29443,7 +29676,7 @@ handler_languages
Optional
SmithyMavenConfiguration
Configuration for smithy maven dependencies.
-Initializer
+Initializer
-Properties
+Properties
@@ -29493,7 +29726,7 @@ repository_urls
Optional
SmithyModelOptions
Options for a Smithy model.
-Initializer
+Initializer
-Properties
+Properties
@@ -29574,7 +29807,7 @@ smithy_build_options
Opti
SmithyProjection
A smithy build projection.
-Initializer
+Initializer
-Properties
+Properties
@@ -29654,7 +29887,7 @@ SmithyServiceName https://awslabs.github.io/smithy/2.0/spec/service-types.html
-Initializer
+Initializer
import aws.pdk.type_safe_api
aws.pdk.type_safe_api.SmithyServiceName(
@@ -29662,7 +29895,7 @@ Initializer service_name: str
)
-Properties
+Properties
@@ -29711,7 +29944,7 @@ service_name
Required
SmithyTransform
A smithy build transform.
-Initializer
+Initializer
import aws.pdk.type_safe_api
aws.pdk.type_safe_api.SmithyTransform(
@@ -29719,7 +29952,7 @@ Initializer name: str
)
-Properties
+Properties
@@ -29750,7 +29983,7 @@ args
Required name
Required
+name
Required
@@ -29760,7 +29993,7 @@ name
Required SnapStartFunctionProps
Options for the SnapStartFunction construct.
-Initializer
+Initializer
-Properties
+Properties
@@ -30501,7 +30734,7 @@ disable_snap_start
Option
TypeSafeApiIntegration
Defines an integration for an individual API operation.
-Initializer
+Initializer
-Properties
+Properties
@@ -30564,14 +30797,14 @@ options
Optional TypeSafeApiIntegrationOptions
Options for an integration.
-Initializer
+Initializer
import aws.pdk.type_safe_api
aws.pdk.type_safe_api.TypeSafeApiIntegrationOptions(
api_key_required: bool = None
)
-Properties
+Properties
@@ -30601,7 +30834,7 @@ api_key_required
Optional
TypeSafeApiModelProjectOptions
-Initializer
+Initializer
-Properties
+Properties
@@ -30710,7 +30943,7 @@ Properties
-name
Required
+name
Required
@@ -30846,7 +31079,7 @@ handler_languages
Optional
TypeSafeApiOptions
Options required alongside an Open API specification to create API Gateway resources.
-Initializer
+Initializer
-Properties
+Properties
@@ -30939,7 +31172,7 @@ default_authorizer
Option
TypeSafeApiProjectOptions
Options for the TypeSafeApiProject.
-Initializer
+Initializer
-Properties
+Properties
@@ -31066,7 +31299,7 @@ Properties
-name
Required
+name
Required
@@ -31228,7 +31461,7 @@ runtime
Optional TypeSafeApiWebAclOptions
Configuration for the Web ACL associated with the API.
-Initializer
+Initializer
-Properties
+Properties
@@ -31296,7 +31529,7 @@ managed_rules
Optional
TypeSafeRestApiProps
Configuration for the TypeSafeRestApi construct.
-Initializer
+Initializer
-Properties
+Properties
@@ -31676,7 +31909,7 @@ web_acl_options
Optional
TypeScriptProjectOptions
TypeScriptProjectOptions.
-Initializer
+Initializer
-Properties
+Properties
@@ -34021,7 +34254,7 @@ authorization_scopes
Op
Scopes for the authorizer, if any.
-Properties
+Properties
@@ -34410,7 +34643,7 @@ authorization_scopes
Requ
the scopes to apply.
-Properties
+Properties
@@ -34668,7 +34901,7 @@ type
Optional https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
-Properties
+Properties
@@ -35009,7 +35242,7 @@ Initializers Properties
+Properties
@@ -35912,7 +36145,7 @@ Initializers Properties
+Properties
diff --git a/api/typescript/type-safe-api/index.html b/api/typescript/type-safe-api/index.html
index 344eee0be..56d50800a 100644
--- a/api/typescript/type-safe-api/index.html
+++ b/api/typescript/type-safe-api/index.html
@@ -3880,6 +3880,13 @@
OperationDetails
+
+
+ -
+
+ PartialManagedRuleGroupStatementProperty
+
+
-
@@ -23302,10 +23309,40 @@
Properties
The name of the managed rule group. |
+excludedRules |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ExcludedRuleProperty[] |
+Rules in the referenced rule group whose actions are set to Count . |
+
+
+managedRuleGroupConfigs |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ManagedRuleGroupConfigProperty[] |
+Additional information that's used by a managed rule group. |
+
+
+ruleActionOverrides |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.RuleActionOverrideProperty[] |
+Action settings to use in the place of the rule actions that are configured inside the rule group. |
+
+
+scopeDownStatement |
+aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.StatementProperty |
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. |
+
+
+version |
+string |
+The version of the managed rule group to use. |
+
+
vendor |
string |
The name of the managed rule group vendor. |
+
+vendorName |
+string |
+The name of the managed rule group vendor. |
+
@@ -23318,7 +23355,64 @@ name
Required vendor
Required
+excludedRules
Optional
+public readonly excludedRules: IResolvable | IResolvable | ExcludedRuleProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ExcludedRuleProperty[]
+
+Rules in the referenced rule group whose actions are set to Count
.
+
+Instead of this option, use RuleActionOverrides
. It accepts any valid action setting, including Count
.
+
+
+managedRuleGroupConfigs
Optional
+public readonly managedRuleGroupConfigs: IResolvable | IResolvable | ManagedRuleGroupConfigProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | 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.
+
+
+ruleActionOverrides
Optional
+public readonly ruleActionOverrides: IResolvable | IResolvable | RuleActionOverrideProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.RuleActionOverrideProperty[]
+
+Action settings to use in the place of the rule actions that are configured inside the rule group.
+You specify one override for each rule whose action you want to change.
+You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
+
+scopeDownStatement
Optional
+public readonly scopeDownStatement: IResolvable | StatementProperty;
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.StatementProperty
+
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
+Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
+
+version
Optional
+public readonly version: string;
+
+
+The version of the managed rule group to use.
+If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
+
+~~vendor
~~Optional
+
+- Deprecated: use the
vendorName
property instead. This property will be removed in the next major release.
+
public readonly vendor: string;
@@ -23327,6 +23421,19 @@ vendor
Required The name of the managed rule group vendor.
You use this, along with the rule group name, to identify the rule group.
+vendorName
Optional
+public readonly vendorName: string;
+
+
+The name of the managed rule group vendor.
+You use this, along with the rule group name, to identify a rule group.
+Preferred to the property vendor
+
+http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html#cfn-wafv2-webacl-managedrulegroupstatement-vendorname
+
+
MethodAndPath
Structure to contain an API operation's method and path.
Initializer
@@ -23745,7 +23852,7 @@ useDocker
Optional OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally
-version
Optional
+version
Optional
public readonly version: string;
@@ -23890,14 +23997,127 @@ contentTypes
Optional
Content types accepted by this operation.
+PartialManagedRuleGroupStatementProperty
+PartialManagedRuleGroupStatementProperty.
+Initializer
+import { PartialManagedRuleGroupStatementProperty } from '@aws/pdk/type-safe-api'
+
+const partialManagedRuleGroupStatementProperty: PartialManagedRuleGroupStatementProperty = { ... }
+
+Properties
+
+
+
+Name |
+Type |
+Description |
+
+
+
+
+name |
+string |
+The name of the managed rule group. |
+
+
+excludedRules |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ExcludedRuleProperty[] |
+Rules in the referenced rule group whose actions are set to Count . |
+
+
+managedRuleGroupConfigs |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ManagedRuleGroupConfigProperty[] |
+Additional information that's used by a managed rule group. |
+
+
+ruleActionOverrides |
+aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.RuleActionOverrideProperty[] |
+Action settings to use in the place of the rule actions that are configured inside the rule group. |
+
+
+scopeDownStatement |
+aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.StatementProperty |
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. |
+
+
+version |
+string |
+The version of the managed rule group to use. |
+
+
+
+
+name
Required
+public readonly name: string;
+
+
+The name of the managed rule group.
+You use this, along with the vendor name, to identify the rule group.
+
+excludedRules
Optional
+public readonly excludedRules: IResolvable | IResolvable | ExcludedRuleProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.ExcludedRuleProperty[]
+
+Rules in the referenced rule group whose actions are set to Count
.
+
+Instead of this option, use RuleActionOverrides
. It accepts any valid action setting, including Count
.
+
+
+managedRuleGroupConfigs
Optional
+public readonly managedRuleGroupConfigs: IResolvable | IResolvable | ManagedRuleGroupConfigProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | 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.
+
+
+ruleActionOverrides
Optional
+public readonly ruleActionOverrides: IResolvable | IResolvable | RuleActionOverrideProperty[];
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.RuleActionOverrideProperty[]
+
+Action settings to use in the place of the rule actions that are configured inside the rule group.
+You specify one override for each rule whose action you want to change.
+You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
+
+scopeDownStatement
Optional
+public readonly scopeDownStatement: IResolvable | StatementProperty;
+
+
+- Type: aws-cdk-lib.IResolvable | aws-cdk-lib.aws_wafv2.CfnWebACL.StatementProperty
+
+An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group.
+Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement
in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
+
+version
Optional
+public readonly version: string;
+
+
+The version of the managed rule group to use.
+If you specify this, the version setting is fixed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
+
ProjectCollections
Collections of projects managed by type-safe-api.
-Initializer
+Initializer
import { ProjectCollections } from '@aws/pdk/type-safe-api'
const projectCollections: ProjectCollections = { ... }
-Properties
+Properties
@@ -24003,12 +24223,12 @@ runtimes
Required PythonProjectOptions
PythonProjectOptions.
-Initializer
+Initializer
import { PythonProjectOptions } from '@aws/pdk/type-safe-api'
const pythonProjectOptions: PythonProjectOptions = { ... }
-Properties
+Properties
@@ -24693,7 +24913,7 @@ staleOptions
Optional Auto-close stale issues and pull requests.
To disable set stale
to false
.
-version
Optional
+version
Optional
public readonly version: string;
@@ -24714,12 +24934,12 @@ vscode
Optional RuntimeConfiguration
Configuration for generated runtime projects.
-Initializer
+Initializer
import { RuntimeConfiguration } from '@aws/pdk/type-safe-api'
const runtimeConfiguration: RuntimeConfiguration = { ... }
-Properties
+Properties
@@ -24763,12 +24983,12 @@ options
Optional S3IntegrationProps
Options for S3Integration.
-Initializer
+Initializer
import { S3IntegrationProps } from '@aws/pdk/type-safe-api'
const s3IntegrationProps: S3IntegrationProps = { ... }
-Properties
+Properties
@@ -24838,12 +25058,12 @@ path
Optional SerializedCorsOptions
Cross-origin resource sharing options.
-Initializer
+Initializer
import { SerializedCorsOptions } from '@aws/pdk/type-safe-api'
const serializedCorsOptions: SerializedCorsOptions = { ... }
-Properties
+Properties
@@ -24910,12 +25130,12 @@ statusCode
Required
SmithyBuildOptions
Options for the smithy build files.
-Initializer
+Initializer
import { SmithyBuildOptions } from '@aws/pdk/type-safe-api'
const smithyBuildOptions: SmithyBuildOptions = { ... }
-Properties
+Properties
@@ -25016,12 +25236,12 @@ projections
Optional
SmithyCommon
Properties common to smithy plugins and the root smithy build.
-Initializer
+Initializer
import { SmithyCommon } from '@aws/pdk/type-safe-api'
const smithyCommon: SmithyCommon = { ... }
-Properties
+Properties
@@ -25062,12 +25282,12 @@ plugins
Optional SmithyDefinitionOptions
Options for a smithy build project.
-Initializer
+Initializer
import { SmithyDefinitionOptions } from '@aws/pdk/type-safe-api'
const smithyDefinitionOptions: SmithyDefinitionOptions = { ... }
-Properties
+Properties
@@ -25108,12 +25328,12 @@ handlerLanguages
Optional
SmithyMavenConfiguration
Configuration for smithy maven dependencies.
-Initializer
+Initializer
import { SmithyMavenConfiguration } from '@aws/pdk/type-safe-api'
const smithyMavenConfiguration: SmithyMavenConfiguration = { ... }
-Properties
+Properties
@@ -25155,12 +25375,12 @@ repositoryUrls
Optional <
SmithyModelOptions
Options for a Smithy model.
-Initializer
+Initializer
import { SmithyModelOptions } from '@aws/pdk/type-safe-api'
const smithyModelOptions: SmithyModelOptions = { ... }
-Properties
+Properties
@@ -25231,12 +25451,12 @@ smithyBuildOptions
Optional
SmithyProjection
A smithy build projection.
-Initializer
+Initializer
import { SmithyProjection } from '@aws/pdk/type-safe-api'
const smithyProjection: SmithyProjection = { ... }
-Properties
+Properties
@@ -25306,12 +25526,12 @@ SmithyServiceName https://awslabs.github.io/smithy/2.0/spec/service-types.html
-Initializer
+Initializer
import { SmithyServiceName } from '@aws/pdk/type-safe-api'
const smithyServiceName: SmithyServiceName = { ... }
-Properties
+Properties
@@ -25360,12 +25580,12 @@ serviceName
Required
SmithyTransform
A smithy build transform.
-Initializer
+Initializer
import { SmithyTransform } from '@aws/pdk/type-safe-api'
const smithyTransform: SmithyTransform = { ... }
-Properties
+Properties
@@ -25396,7 +25616,7 @@ args
Required name
Required
+name
Required
public readonly name: string;
@@ -25406,12 +25626,12 @@ name
Required SnapStartFunctionProps
Options for the SnapStartFunction construct.
-Initializer
+Initializer
import { SnapStartFunctionProps } from '@aws/pdk/type-safe-api'
const snapStartFunctionProps: SnapStartFunctionProps = { ... }
-Properties
+Properties
@@ -26103,12 +26323,12 @@ disableSnapStart
Optional
TypeSafeApiIntegration
Defines an integration for an individual API operation.
-Initializer
+Initializer
import { TypeSafeApiIntegration } from '@aws/pdk/type-safe-api'
const typeSafeApiIntegration: TypeSafeApiIntegration = { ... }
-Properties
+Properties