CfnRuleGroup

class aws_cdk.aws_wafv2.CfnRuleGroup(scope_, id, *, capacity, scope, visibility_config, custom_response_bodies=None, description=None, name=None, rules=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::WAFv2::RuleGroup.

CloudformationResource

AWS::WAFv2::RuleGroup

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html

Create a new AWS::WAFv2::RuleGroup.

Parameters
  • scope (str) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • capacity (Union[int, float]) – AWS::WAFv2::RuleGroup.Capacity.

  • scopeAWS::WAFv2::RuleGroup.Scope.

  • visibility_config (Union[IResolvable, VisibilityConfigProperty]) – AWS::WAFv2::RuleGroup.VisibilityConfig.

  • custom_response_bodies (Union[IResolvable, Mapping[str, Union[IResolvable, CustomResponseBodyProperty]], None]) – AWS::WAFv2::RuleGroup.CustomResponseBodies.

  • description (Optional[str]) – AWS::WAFv2::RuleGroup.Description.

  • name (Optional[str]) – AWS::WAFv2::RuleGroup.Name.

  • rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty]], None]) – AWS::WAFv2::RuleGroup.Rules.

  • tags (Optional[Sequence[CfnTag]]) – AWS::WAFv2::RuleGroup.Tags.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::WAFv2::RuleGroup'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_available_labels

AvailableLabels

Type

cloudformationAttribute

Return type

IResolvable

attr_consumed_labels

ConsumedLabels

Type

cloudformationAttribute

Return type

IResolvable

attr_id

Id

Type

cloudformationAttribute

Return type

str

attr_label_namespace

LabelNamespace

Type

cloudformationAttribute

Return type

str

capacity

AWS::WAFv2::RuleGroup.Capacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-capacity

Return type

Union[int, float]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

custom_response_bodies

AWS::WAFv2::RuleGroup.CustomResponseBodies.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-customresponsebodies

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, CustomResponseBodyProperty]], None]

description

AWS::WAFv2::RuleGroup.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-description

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

AWS::WAFv2::RuleGroup.Name.

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

rules

AWS::WAFv2::RuleGroup.Rules.

Link

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

Return type

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

scope

AWS::WAFv2::RuleGroup.Scope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-scope

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::WAFv2::RuleGroup.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-tags

Return type

TagManager

visibility_config

AWS::WAFv2::RuleGroup.VisibilityConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html#cfn-wafv2-rulegroup-visibilityconfig

Return type

Union[IResolvable, VisibilityConfigProperty]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AndStatementProperty

class CfnRuleGroup.AndStatementProperty(*, statements)

Bases: object

Parameters

statements (Union[IResolvable, Sequence[Union[IResolvable, StatementProperty]]]) – CfnRuleGroup.AndStatementProperty.Statements.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html

Attributes

statements

CfnRuleGroup.AndStatementProperty.Statements.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html#cfn-wafv2-rulegroup-andstatement-statements

Return type

Union[IResolvable, List[Union[IResolvable, StatementProperty]]]

ByteMatchStatementProperty

class CfnRuleGroup.ByteMatchStatementProperty(*, field_to_match, positional_constraint, text_transformations, search_string=None, search_string_base64=None)

Bases: object

Parameters
  • field_to_match (Union[IResolvable, FieldToMatchProperty]) – CfnRuleGroup.ByteMatchStatementProperty.FieldToMatch.

  • positional_constraint (str) – CfnRuleGroup.ByteMatchStatementProperty.PositionalConstraint.

  • text_transformations (Union[IResolvable, Sequence[Union[IResolvable, TextTransformationProperty]]]) – CfnRuleGroup.ByteMatchStatementProperty.TextTransformations.

  • search_string (Optional[str]) – CfnRuleGroup.ByteMatchStatementProperty.SearchString.

  • search_string_base64 (Optional[str]) – CfnRuleGroup.ByteMatchStatementProperty.SearchStringBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html

Attributes

field_to_match

CfnRuleGroup.ByteMatchStatementProperty.FieldToMatch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-fieldtomatch

Return type

Union[IResolvable, FieldToMatchProperty]

positional_constraint

CfnRuleGroup.ByteMatchStatementProperty.PositionalConstraint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-positionalconstraint

Return type

str

search_string

CfnRuleGroup.ByteMatchStatementProperty.SearchString.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstring

Return type

Optional[str]

search_string_base64

CfnRuleGroup.ByteMatchStatementProperty.SearchStringBase64.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-searchstringbase64

Return type

Optional[str]

text_transformations

CfnRuleGroup.ByteMatchStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html#cfn-wafv2-rulegroup-bytematchstatement-texttransformations

Return type

Union[IResolvable, List[Union[IResolvable, TextTransformationProperty]]]

CustomResponseBodyProperty

class CfnRuleGroup.CustomResponseBodyProperty(*, content, content_type)

Bases: object

Parameters
  • content (str) – CfnRuleGroup.CustomResponseBodyProperty.Content.

  • content_type (str) – CfnRuleGroup.CustomResponseBodyProperty.ContentType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html

Attributes

content

CfnRuleGroup.CustomResponseBodyProperty.Content.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html#cfn-wafv2-rulegroup-customresponsebody-content

Return type

str

content_type

CfnRuleGroup.CustomResponseBodyProperty.ContentType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html#cfn-wafv2-rulegroup-customresponsebody-contenttype

Return type

str

FieldToMatchProperty

class CfnRuleGroup.FieldToMatchProperty(*, all_query_arguments=None, body=None, json_body=None, method=None, query_string=None, single_header=None, single_query_argument=None, uri_path=None)

Bases: object

Parameters
  • all_query_arguments (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.AllQueryArguments.

  • body (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.Body.

  • json_body (Union[IResolvable, JsonBodyProperty, None]) – CfnRuleGroup.FieldToMatchProperty.JsonBody.

  • method (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.Method.

  • query_string (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.QueryString.

  • single_header (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.SingleHeader.

  • single_query_argument (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.SingleQueryArgument.

  • uri_path (Optional[Any]) – CfnRuleGroup.FieldToMatchProperty.UriPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html

Attributes

all_query_arguments

CfnRuleGroup.FieldToMatchProperty.AllQueryArguments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments

Return type

Any

body

CfnRuleGroup.FieldToMatchProperty.Body.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-body

Return type

Any

json_body

CfnRuleGroup.FieldToMatchProperty.JsonBody.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-jsonbody

Return type

Union[IResolvable, JsonBodyProperty, None]

method

CfnRuleGroup.FieldToMatchProperty.Method.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-method

Return type

Any

query_string

CfnRuleGroup.FieldToMatchProperty.QueryString.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-querystring

Return type

Any

single_header

CfnRuleGroup.FieldToMatchProperty.SingleHeader.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singleheader

Return type

Any

single_query_argument

CfnRuleGroup.FieldToMatchProperty.SingleQueryArgument.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument

Return type

Any

uri_path

CfnRuleGroup.FieldToMatchProperty.UriPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html#cfn-wafv2-rulegroup-fieldtomatch-uripath

Return type

Any

ForwardedIPConfigurationProperty

class CfnRuleGroup.ForwardedIPConfigurationProperty(*, fallback_behavior, header_name)

Bases: object

Parameters
  • fallback_behavior (str) – CfnRuleGroup.ForwardedIPConfigurationProperty.FallbackBehavior.

  • header_name (str) – CfnRuleGroup.ForwardedIPConfigurationProperty.HeaderName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html

Attributes

fallback_behavior

CfnRuleGroup.ForwardedIPConfigurationProperty.FallbackBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-fallbackbehavior

Return type

str

header_name

CfnRuleGroup.ForwardedIPConfigurationProperty.HeaderName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html#cfn-wafv2-rulegroup-forwardedipconfiguration-headername

Return type

str

GeoMatchStatementProperty

class CfnRuleGroup.GeoMatchStatementProperty(*, country_codes=None, forwarded_ip_config=None)

Bases: object

Parameters
  • country_codes (Optional[Sequence[str]]) – CfnRuleGroup.GeoMatchStatementProperty.CountryCodes.

  • forwarded_ip_config (Union[IResolvable, ForwardedIPConfigurationProperty, None]) – CfnRuleGroup.GeoMatchStatementProperty.ForwardedIPConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html

Attributes

country_codes

CfnRuleGroup.GeoMatchStatementProperty.CountryCodes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-countrycodes

Return type

Optional[List[str]]

forwarded_ip_config

CfnRuleGroup.GeoMatchStatementProperty.ForwardedIPConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html#cfn-wafv2-rulegroup-geomatchstatement-forwardedipconfig

Return type

Union[IResolvable, ForwardedIPConfigurationProperty, None]

JsonBodyProperty

class CfnRuleGroup.JsonBodyProperty(*, match_pattern, match_scope, invalid_fallback_behavior=None)

Bases: object

Parameters
  • match_pattern (Union[IResolvable, JsonMatchPatternProperty]) – CfnRuleGroup.JsonBodyProperty.MatchPattern.

  • match_scope (str) – CfnRuleGroup.JsonBodyProperty.MatchScope.

  • invalid_fallback_behavior (Optional[str]) – CfnRuleGroup.JsonBodyProperty.InvalidFallbackBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html

Attributes

invalid_fallback_behavior

CfnRuleGroup.JsonBodyProperty.InvalidFallbackBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-invalidfallbackbehavior

Return type

Optional[str]

match_pattern

CfnRuleGroup.JsonBodyProperty.MatchPattern.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-matchpattern

Return type

Union[IResolvable, JsonMatchPatternProperty]

match_scope

CfnRuleGroup.JsonBodyProperty.MatchScope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html#cfn-wafv2-rulegroup-jsonbody-matchscope

Return type

str

JsonMatchPatternProperty

class CfnRuleGroup.JsonMatchPatternProperty(*, all=None, included_paths=None)

Bases: object

Parameters
  • all (Optional[Any]) – CfnRuleGroup.JsonMatchPatternProperty.All.

  • included_paths (Optional[Sequence[str]]) – CfnRuleGroup.JsonMatchPatternProperty.IncludedPaths.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html

Attributes

all

CfnRuleGroup.JsonMatchPatternProperty.All.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-all

Return type

Any

included_paths

CfnRuleGroup.JsonMatchPatternProperty.IncludedPaths.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html#cfn-wafv2-rulegroup-jsonmatchpattern-includedpaths

Return type

Optional[List[str]]

LabelMatchStatementProperty

class CfnRuleGroup.LabelMatchStatementProperty(*, key, scope)

Bases: object

Parameters
  • key (str) – CfnRuleGroup.LabelMatchStatementProperty.Key.

  • scope (str) – CfnRuleGroup.LabelMatchStatementProperty.Scope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html

Attributes

key

CfnRuleGroup.LabelMatchStatementProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html#cfn-wafv2-rulegroup-labelmatchstatement-key

Return type

str

scope

CfnRuleGroup.LabelMatchStatementProperty.Scope.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html#cfn-wafv2-rulegroup-labelmatchstatement-scope

Return type

str

LabelProperty

class CfnRuleGroup.LabelProperty(*, name)

Bases: object

Parameters

name (str) – CfnRuleGroup.LabelProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-label.html

Attributes

name

CfnRuleGroup.LabelProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-label.html#cfn-wafv2-rulegroup-label-name

Return type

str

LabelSummaryProperty

class CfnRuleGroup.LabelSummaryProperty(*, name=None)

Bases: object

Parameters

name (Optional[str]) – CfnRuleGroup.LabelSummaryProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html

Attributes

name

CfnRuleGroup.LabelSummaryProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html#cfn-wafv2-rulegroup-labelsummary-name

Return type

Optional[str]

NotStatementProperty

class CfnRuleGroup.NotStatementProperty(*, statement)

Bases: object

Parameters

statement (Union[IResolvable, StatementProperty]) – CfnRuleGroup.NotStatementProperty.Statement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html

Attributes

statement

CfnRuleGroup.NotStatementProperty.Statement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html#cfn-wafv2-rulegroup-notstatement-statement

Return type

Union[IResolvable, StatementProperty]

OrStatementProperty

class CfnRuleGroup.OrStatementProperty(*, statements)

Bases: object

Parameters

statements (Union[IResolvable, Sequence[Union[IResolvable, StatementProperty]]]) – CfnRuleGroup.OrStatementProperty.Statements.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html

Attributes

statements

CfnRuleGroup.OrStatementProperty.Statements.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html#cfn-wafv2-rulegroup-orstatement-statements

Return type

Union[IResolvable, List[Union[IResolvable, StatementProperty]]]

RateBasedStatementProperty

class CfnRuleGroup.RateBasedStatementProperty(*, aggregate_key_type, limit, forwarded_ip_config=None, scope_down_statement=None)

Bases: object

Parameters
  • aggregate_key_type (str) – CfnRuleGroup.RateBasedStatementProperty.AggregateKeyType.

  • limit (Union[int, float]) – CfnRuleGroup.RateBasedStatementProperty.Limit.

  • forwarded_ip_config (Union[IResolvable, ForwardedIPConfigurationProperty, None]) – CfnRuleGroup.RateBasedStatementProperty.ForwardedIPConfig.

  • scope_down_statement (Union[IResolvable, StatementProperty, None]) – CfnRuleGroup.RateBasedStatementProperty.ScopeDownStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html

Attributes

aggregate_key_type

CfnRuleGroup.RateBasedStatementProperty.AggregateKeyType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-aggregatekeytype

Return type

str

forwarded_ip_config

CfnRuleGroup.RateBasedStatementProperty.ForwardedIPConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-forwardedipconfig

Return type

Union[IResolvable, ForwardedIPConfigurationProperty, None]

limit

CfnRuleGroup.RateBasedStatementProperty.Limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-limit

Return type

Union[int, float]

scope_down_statement

CfnRuleGroup.RateBasedStatementProperty.ScopeDownStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html#cfn-wafv2-rulegroup-ratebasedstatement-scopedownstatement

Return type

Union[IResolvable, StatementProperty, None]

RegexPatternSetReferenceStatementProperty

class CfnRuleGroup.RegexPatternSetReferenceStatementProperty(*, arn, field_to_match, text_transformations)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html

Attributes

arn

CfnRuleGroup.RegexPatternSetReferenceStatementProperty.Arn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-arn

Return type

str

field_to_match

CfnRuleGroup.RegexPatternSetReferenceStatementProperty.FieldToMatch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-fieldtomatch

Return type

Union[IResolvable, FieldToMatchProperty]

text_transformations

CfnRuleGroup.RegexPatternSetReferenceStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html#cfn-wafv2-rulegroup-regexpatternsetreferencestatement-texttransformations

Return type

Union[IResolvable, List[Union[IResolvable, TextTransformationProperty]]]

RuleActionProperty

class CfnRuleGroup.RuleActionProperty(*, allow=None, block=None, count=None)

Bases: object

Parameters
  • allow (Optional[Any]) – CfnRuleGroup.RuleActionProperty.Allow.

  • block (Optional[Any]) – CfnRuleGroup.RuleActionProperty.Block.

  • count (Optional[Any]) – CfnRuleGroup.RuleActionProperty.Count.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html

Attributes

allow

CfnRuleGroup.RuleActionProperty.Allow.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-allow

Return type

Any

block

CfnRuleGroup.RuleActionProperty.Block.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-block

Return type

Any

count

CfnRuleGroup.RuleActionProperty.Count.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html#cfn-wafv2-rulegroup-ruleaction-count

Return type

Any

RuleProperty

class CfnRuleGroup.RuleProperty(*, name, priority, statement, visibility_config, action=None, rule_labels=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html

Attributes

action

CfnRuleGroup.RuleProperty.Action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-action

Return type

Union[IResolvable, RuleActionProperty, None]

name

CfnRuleGroup.RuleProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-name

Return type

str

priority

CfnRuleGroup.RuleProperty.Priority.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-priority

Return type

Union[int, float]

rule_labels

CfnRuleGroup.RuleProperty.RuleLabels.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-rulelabels

Return type

Union[IResolvable, List[Union[IResolvable, LabelProperty]], None]

statement

CfnRuleGroup.RuleProperty.Statement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-statement

Return type

Union[IResolvable, StatementProperty]

visibility_config

CfnRuleGroup.RuleProperty.VisibilityConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html#cfn-wafv2-rulegroup-rule-visibilityconfig

Return type

Union[IResolvable, VisibilityConfigProperty]

SizeConstraintStatementProperty

class CfnRuleGroup.SizeConstraintStatementProperty(*, comparison_operator, field_to_match, size, text_transformations)

Bases: object

Parameters
  • comparison_operator (str) – CfnRuleGroup.SizeConstraintStatementProperty.ComparisonOperator.

  • field_to_match (Union[IResolvable, FieldToMatchProperty]) – CfnRuleGroup.SizeConstraintStatementProperty.FieldToMatch.

  • size (Union[int, float]) – CfnRuleGroup.SizeConstraintStatementProperty.Size.

  • text_transformations (Union[IResolvable, Sequence[Union[IResolvable, TextTransformationProperty]]]) – CfnRuleGroup.SizeConstraintStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html

Attributes

comparison_operator

CfnRuleGroup.SizeConstraintStatementProperty.ComparisonOperator.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-comparisonoperator

Return type

str

field_to_match

CfnRuleGroup.SizeConstraintStatementProperty.FieldToMatch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-fieldtomatch

Return type

Union[IResolvable, FieldToMatchProperty]

size

CfnRuleGroup.SizeConstraintStatementProperty.Size.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-size

Return type

Union[int, float]

text_transformations

CfnRuleGroup.SizeConstraintStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html#cfn-wafv2-rulegroup-sizeconstraintstatement-texttransformations

Return type

Union[IResolvable, List[Union[IResolvable, TextTransformationProperty]]]

SqliMatchStatementProperty

class CfnRuleGroup.SqliMatchStatementProperty(*, field_to_match, text_transformations)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html

Attributes

field_to_match

CfnRuleGroup.SqliMatchStatementProperty.FieldToMatch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-fieldtomatch

Return type

Union[IResolvable, FieldToMatchProperty]

text_transformations

CfnRuleGroup.SqliMatchStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html#cfn-wafv2-rulegroup-sqlimatchstatement-texttransformations

Return type

Union[IResolvable, List[Union[IResolvable, TextTransformationProperty]]]

StatementProperty

class CfnRuleGroup.StatementProperty(*, and_statement=None, byte_match_statement=None, geo_match_statement=None, ip_set_reference_statement=None, label_match_statement=None, not_statement=None, or_statement=None, rate_based_statement=None, regex_pattern_set_reference_statement=None, size_constraint_statement=None, sqli_match_statement=None, xss_match_statement=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html

Attributes

and_statement

CfnRuleGroup.StatementProperty.AndStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-andstatement

Return type

Union[IResolvable, AndStatementProperty, None]

byte_match_statement

CfnRuleGroup.StatementProperty.ByteMatchStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement

Return type

Union[IResolvable, ByteMatchStatementProperty, None]

geo_match_statement

CfnRuleGroup.StatementProperty.GeoMatchStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-geomatchstatement

Return type

Union[IResolvable, GeoMatchStatementProperty, None]

ip_set_reference_statement

CfnRuleGroup.StatementProperty.IPSetReferenceStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-ipsetreferencestatement

Return type

Union[IResolvable, IPSetReferenceStatementProperty, None]

label_match_statement

CfnRuleGroup.StatementProperty.LabelMatchStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-labelmatchstatement

Return type

Union[IResolvable, LabelMatchStatementProperty, None]

not_statement

CfnRuleGroup.StatementProperty.NotStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-notstatement

Return type

Union[IResolvable, NotStatementProperty, None]

or_statement

CfnRuleGroup.StatementProperty.OrStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-orstatement

Return type

Union[IResolvable, OrStatementProperty, None]

rate_based_statement

CfnRuleGroup.StatementProperty.RateBasedStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-ratebasedstatement

Return type

Union[IResolvable, RateBasedStatementProperty, None]

regex_pattern_set_reference_statement

CfnRuleGroup.StatementProperty.RegexPatternSetReferenceStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexpatternsetreferencestatement

Return type

Union[IResolvable, RegexPatternSetReferenceStatementProperty, None]

size_constraint_statement

CfnRuleGroup.StatementProperty.SizeConstraintStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement

Return type

Union[IResolvable, SizeConstraintStatementProperty, None]

sqli_match_statement

CfnRuleGroup.StatementProperty.SqliMatchStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sqlimatchstatement

Return type

Union[IResolvable, SqliMatchStatementProperty, None]

xss_match_statement

CfnRuleGroup.StatementProperty.XssMatchStatement.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-xssmatchstatement

Return type

Union[IResolvable, XssMatchStatementProperty, None]

TextTransformationProperty

class CfnRuleGroup.TextTransformationProperty(*, priority, type)

Bases: object

Parameters
  • priority (Union[int, float]) – CfnRuleGroup.TextTransformationProperty.Priority.

  • type (str) – CfnRuleGroup.TextTransformationProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html

Attributes

priority

CfnRuleGroup.TextTransformationProperty.Priority.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-priority

Return type

Union[int, float]

type

CfnRuleGroup.TextTransformationProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html#cfn-wafv2-rulegroup-texttransformation-type

Return type

str

VisibilityConfigProperty

class CfnRuleGroup.VisibilityConfigProperty(*, cloud_watch_metrics_enabled, metric_name, sampled_requests_enabled)

Bases: object

Parameters
  • cloud_watch_metrics_enabled (Union[bool, IResolvable]) – CfnRuleGroup.VisibilityConfigProperty.CloudWatchMetricsEnabled.

  • metric_name (str) – CfnRuleGroup.VisibilityConfigProperty.MetricName.

  • sampled_requests_enabled (Union[bool, IResolvable]) – CfnRuleGroup.VisibilityConfigProperty.SampledRequestsEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html

Attributes

cloud_watch_metrics_enabled

CfnRuleGroup.VisibilityConfigProperty.CloudWatchMetricsEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-cloudwatchmetricsenabled

Return type

Union[bool, IResolvable]

metric_name

CfnRuleGroup.VisibilityConfigProperty.MetricName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-metricname

Return type

str

sampled_requests_enabled

CfnRuleGroup.VisibilityConfigProperty.SampledRequestsEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html#cfn-wafv2-rulegroup-visibilityconfig-sampledrequestsenabled

Return type

Union[bool, IResolvable]

XssMatchStatementProperty

class CfnRuleGroup.XssMatchStatementProperty(*, field_to_match, text_transformations)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html

Attributes

field_to_match

CfnRuleGroup.XssMatchStatementProperty.FieldToMatch.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-fieldtomatch

Return type

Union[IResolvable, FieldToMatchProperty]

text_transformations

CfnRuleGroup.XssMatchStatementProperty.TextTransformations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html#cfn-wafv2-rulegroup-xssmatchstatement-texttransformations

Return type

Union[IResolvable, List[Union[IResolvable, TextTransformationProperty]]]