CfnWebACLProps

class aws_cdk.aws_wafregional.CfnWebACLProps(*, default_action, metric_name, name, rules=None)

Bases: object

Properties for defining a CfnWebACL.

Parameters
  • default_action (Union[IResolvable, ActionProperty]) – The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

  • metric_name (str) – A name for the metrics for this WebACL . The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change MetricName after you create the WebACL .

  • name (str) – A friendly name or description of the WebACL . You can’t change the name of a WebACL after you create it.

  • rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty]], None]) – An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_wafregional as wafregional

cfn_web_aCLProps = wafregional.CfnWebACLProps(
    default_action=wafregional.CfnWebACL.ActionProperty(
        type="type"
    ),
    metric_name="metricName",
    name="name",

    # the properties below are optional
    rules=[wafregional.CfnWebACL.RuleProperty(
        action=wafregional.CfnWebACL.ActionProperty(
            type="type"
        ),
        priority=123,
        rule_id="ruleId"
    )]
)

Attributes

default_action

The action to perform if none of the Rules contained in the WebACL match.

The action is specified by the WafAction object.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-defaultaction

Return type

Union[IResolvable, ActionProperty]

metric_name

A name for the metrics for this WebACL .

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change MetricName after you create the WebACL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-metricname

Return type

str

name

A friendly name or description of the WebACL .

You can’t change the name of a WebACL after you create it.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-name

Return type

str

rules

An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-webacl.html#cfn-wafregional-webacl-rules

Return type

Union[IResolvable, List[Union[IResolvable, RuleProperty]], None]