AWS Native v0.102.0, Apr 16 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.wafv2.RuleGroup

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Contains the Rules that identify the requests that you want to allow, block, or count. In a RuleGroup, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a RuleGroup, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the RuleGroup with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a RuleGroup, a request needs to match only one of the specifications to be allowed, blocked, or counted.

Create RuleGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RuleGroup(name: string, args: RuleGroupArgs, opts?: CustomResourceOptions);

@overload
def RuleGroup(resource_name: str,
              args: RuleGroupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def RuleGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              capacity: Optional[int] = None,
              scope: Optional[RuleGroupScope] = None,
              visibility_config: Optional[RuleGroupVisibilityConfigArgs] = None,
              available_labels: Optional[Sequence[RuleGroupLabelSummaryArgs]] = None,
              consumed_labels: Optional[Sequence[RuleGroupLabelSummaryArgs]] = None,
              custom_response_bodies: Optional[Mapping[str, RuleGroupCustomResponseBodyArgs]] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              rules: Optional[Sequence[RuleGroupRuleArgs]] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewRuleGroup(ctx *Context, name string, args RuleGroupArgs, opts ...ResourceOption) (*RuleGroup, error)

public RuleGroup(string name, RuleGroupArgs args, CustomResourceOptions? opts = null)

public RuleGroup(String name, RuleGroupArgs args)
public RuleGroup(String name, RuleGroupArgs args, CustomResourceOptions options)

type: aws-native:wafv2:RuleGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RuleGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RuleGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RuleGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RuleGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RuleGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const aws_nativeRuleGroupResource = new aws_native.wafv2.RuleGroup("aws-nativeRuleGroupResource", {
    capacity: 0,
    scope: aws_native.wafv2.RuleGroupScope.Cloudfront,
    visibilityConfig: {
        cloudWatchMetricsEnabled: false,
        metricName: "string",
        sampledRequestsEnabled: false,
    },
    availableLabels: [{
        name: "string",
    }],
    consumedLabels: [{
        name: "string",
    }],
    customResponseBodies: {
        string: {
            content: "string",
            contentType: aws_native.wafv2.RuleGroupResponseContentType.TextPlain,
        },
    },
    description: "string",
    name: "string",
    rules: [{
        name: "string",
        priority: 0,
        statement: {
            andStatement: {
                statements: [ruleGroupStatement],
            },
            byteMatchStatement: {
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                positionalConstraint: aws_native.wafv2.RuleGroupPositionalConstraint.Exactly,
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
                searchString: "string",
                searchStringBase64: "string",
            },
            geoMatchStatement: {
                countryCodes: ["string"],
                forwardedIpConfig: {
                    fallbackBehavior: aws_native.wafv2.RuleGroupForwardedIpConfigurationFallbackBehavior.Match,
                    headerName: "string",
                },
            },
            ipSetReferenceStatement: {
                arn: "string",
                ipSetForwardedIpConfig: {
                    fallbackBehavior: aws_native.wafv2.RuleGroupIpSetForwardedIpConfigurationFallbackBehavior.Match,
                    headerName: "string",
                    position: aws_native.wafv2.RuleGroupIpSetForwardedIpConfigurationPosition.First,
                },
            },
            labelMatchStatement: {
                key: "string",
                scope: aws_native.wafv2.RuleGroupLabelMatchScope.Label,
            },
            notStatement: {
                statement: ruleGroupStatement,
            },
            orStatement: {
                statements: [ruleGroupStatement],
            },
            rateBasedStatement: {
                aggregateKeyType: aws_native.wafv2.RuleGroupRateBasedStatementAggregateKeyType.Ip,
                limit: 0,
                customKeys: [{
                    cookie: {
                        name: "string",
                        textTransformations: [{
                            priority: 0,
                            type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                        }],
                    },
                    forwardedIp: {},
                    header: {
                        name: "string",
                        textTransformations: [{
                            priority: 0,
                            type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                        }],
                    },
                    httpMethod: {},
                    ip: {},
                    labelNamespace: {
                        namespace: "string",
                    },
                    queryArgument: {
                        name: "string",
                        textTransformations: [{
                            priority: 0,
                            type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                        }],
                    },
                    queryString: {
                        textTransformations: [{
                            priority: 0,
                            type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                        }],
                    },
                    uriPath: {
                        textTransformations: [{
                            priority: 0,
                            type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                        }],
                    },
                }],
                evaluationWindowSec: 0,
                forwardedIpConfig: {
                    fallbackBehavior: aws_native.wafv2.RuleGroupForwardedIpConfigurationFallbackBehavior.Match,
                    headerName: "string",
                },
                scopeDownStatement: ruleGroupStatement,
            },
            regexMatchStatement: {
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                regexString: "string",
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
            },
            regexPatternSetReferenceStatement: {
                arn: "string",
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
            },
            sizeConstraintStatement: {
                comparisonOperator: aws_native.wafv2.RuleGroupSizeConstraintStatementComparisonOperator.Eq,
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                size: 0,
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
            },
            sqliMatchStatement: {
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
                sensitivityLevel: aws_native.wafv2.RuleGroupSensitivityLevel.Low,
            },
            xssMatchStatement: {
                fieldToMatch: {
                    allQueryArguments: "any",
                    body: {
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    cookies: {
                        matchPattern: {
                            all: "any",
                            excludedCookies: ["string"],
                            includedCookies: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    headers: {
                        matchPattern: {
                            all: "any",
                            excludedHeaders: ["string"],
                            includedHeaders: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupMapMatchScope.All,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    ja3Fingerprint: {
                        fallbackBehavior: aws_native.wafv2.RuleGroupJa3FingerprintFallbackBehavior.Match,
                    },
                    jsonBody: {
                        matchPattern: {
                            all: "any",
                            includedPaths: ["string"],
                        },
                        matchScope: aws_native.wafv2.RuleGroupJsonMatchScope.All,
                        invalidFallbackBehavior: aws_native.wafv2.RuleGroupBodyParsingFallbackBehavior.Match,
                        oversizeHandling: aws_native.wafv2.RuleGroupOversizeHandling.Continue,
                    },
                    method: "any",
                    queryString: "any",
                    singleHeader: {
                        name: "string",
                    },
                    singleQueryArgument: {
                        name: "string",
                    },
                    uriPath: "any",
                },
                textTransformations: [{
                    priority: 0,
                    type: aws_native.wafv2.RuleGroupTextTransformationType.None,
                }],
            },
        },
        visibilityConfig: {
            cloudWatchMetricsEnabled: false,
            metricName: "string",
            sampledRequestsEnabled: false,
        },
        action: {
            allow: {
                customRequestHandling: {
                    insertHeaders: [{
                        name: "string",
                        value: "string",
                    }],
                },
            },
            block: {
                customResponse: {
                    responseCode: 0,
                    customResponseBodyKey: "string",
                    responseHeaders: [{
                        name: "string",
                        value: "string",
                    }],
                },
            },
            captcha: {
                customRequestHandling: {
                    insertHeaders: [{
                        name: "string",
                        value: "string",
                    }],
                },
            },
            challenge: {
                customRequestHandling: {
                    insertHeaders: [{
                        name: "string",
                        value: "string",
                    }],
                },
            },
            count: {
                customRequestHandling: {
                    insertHeaders: [{
                        name: "string",
                        value: "string",
                    }],
                },
            },
        },
        captchaConfig: {
            immunityTimeProperty: {
                immunityTime: 0,
            },
        },
        challengeConfig: {
            immunityTimeProperty: {
                immunityTime: 0,
            },
        },
        ruleLabels: [{
            name: "string",
        }],
    }],
    tags: [{
        key: "string",
        value: "string",
    }],
});

Coming soon!

RuleGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RuleGroup resource accepts the following input properties:

Capacity int
Scope Pulumi.AwsNative.WaFv2.RuleGroupScope
VisibilityConfig Pulumi.AwsNative.WaFv2.Inputs.RuleGroupVisibilityConfig
AvailableLabels List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupLabelSummary>: Collection of Available Labels.
ConsumedLabels List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupLabelSummary>: Collection of Consumed Labels.
CustomResponseBodies Dictionary<string, Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomResponseBodyArgs>
Description string
Name string
Rules List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupRule>: Collection of Rules.
Tags List<Pulumi.AwsNative.Inputs.Tag>

Capacity int
Scope RuleGroupScope
VisibilityConfig RuleGroupVisibilityConfigArgs
AvailableLabels []RuleGroupLabelSummaryArgs: Collection of Available Labels.
ConsumedLabels []RuleGroupLabelSummaryArgs: Collection of Consumed Labels.
CustomResponseBodies map[string]RuleGroupCustomResponseBodyArgs
Description string
Name string
Rules []RuleGroupRuleArgs: Collection of Rules.
Tags TagArgs

capacity Integer
scope RuleGroupScope
visibilityConfig RuleGroupVisibilityConfig
availableLabels List<RuleGroupLabelSummary>: Collection of Available Labels.
consumedLabels List<RuleGroupLabelSummary>: Collection of Consumed Labels.
customResponseBodies Map<String,RuleGroupCustomResponseBodyArgs>
description String
name String
rules List<RuleGroupRule>: Collection of Rules.
tags List<Tag>

capacity number
scope RuleGroupScope
visibilityConfig RuleGroupVisibilityConfig
availableLabels RuleGroupLabelSummary[]: Collection of Available Labels.
consumedLabels RuleGroupLabelSummary[]: Collection of Consumed Labels.
customResponseBodies {[key: string]: RuleGroupCustomResponseBodyArgs}
description string
name string
rules RuleGroupRule[]: Collection of Rules.
tags Tag[]

capacity int
scope RuleGroupScope
visibility_config RuleGroupVisibilityConfigArgs
available_labels Sequence[RuleGroupLabelSummaryArgs]: Collection of Available Labels.
consumed_labels Sequence[RuleGroupLabelSummaryArgs]: Collection of Consumed Labels.
custom_response_bodies Mapping[str, RuleGroupCustomResponseBodyArgs]
description str
name str
rules Sequence[RuleGroupRuleArgs]: Collection of Rules.
tags Sequence[TagArgs]

capacity Number
scope "CLOUDFRONT" | "REGIONAL"
visibilityConfig Property Map
availableLabels List<Property Map>: Collection of Available Labels.
consumedLabels List<Property Map>: Collection of Consumed Labels.
customResponseBodies Map<Property Map>
description String
name String
rules List<Property Map>: Collection of Rules.
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the RuleGroup resource produces the following output properties:

Arn string
AwsId string
Id string: The provider-assigned unique ID for this managed resource.
LabelNamespace string

Arn string
AwsId string
Id string: The provider-assigned unique ID for this managed resource.
LabelNamespace string

arn String
awsId String
id String: The provider-assigned unique ID for this managed resource.
labelNamespace String

arn string
awsId string
id string: The provider-assigned unique ID for this managed resource.
labelNamespace string

arn str
aws_id str
id str: The provider-assigned unique ID for this managed resource.
label_namespace str

arn String
awsId String
id String: The provider-assigned unique ID for this managed resource.
labelNamespace String

Supporting Types

RuleGroupBodyParsingFallbackBehavior, RuleGroupBodyParsingFallbackBehaviorArgs

Match: MATCH
NoMatch: NO_MATCH
EvaluateAsString: EVALUATE_AS_STRING

RuleGroupBodyParsingFallbackBehaviorMatch: MATCH
RuleGroupBodyParsingFallbackBehaviorNoMatch: NO_MATCH
RuleGroupBodyParsingFallbackBehaviorEvaluateAsString: EVALUATE_AS_STRING

Match: MATCH
NoMatch: NO_MATCH
EvaluateAsString: EVALUATE_AS_STRING

Match: MATCH
NoMatch: NO_MATCH
EvaluateAsString: EVALUATE_AS_STRING

MATCH: MATCH
NO_MATCH: NO_MATCH
EVALUATE_AS_STRING: EVALUATE_AS_STRING

"MATCH": MATCH
"NO_MATCH": NO_MATCH
"EVALUATE_AS_STRING": EVALUATE_AS_STRING

RuleGroupByteMatchStatement, RuleGroupByteMatchStatementArgs

FieldToMatch Pulumi.AwsNative.WaFv2.Inputs.RuleGroupFieldToMatch
PositionalConstraint Pulumi.AwsNative.WaFv2.RuleGroupPositionalConstraint
TextTransformations List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupTextTransformation>
SearchString string
SearchStringBase64 string

FieldToMatch RuleGroupFieldToMatch
PositionalConstraint RuleGroupPositionalConstraint
TextTransformations []RuleGroupTextTransformation
SearchString string
SearchStringBase64 string

fieldToMatch RuleGroupFieldToMatch
positionalConstraint RuleGroupPositionalConstraint
textTransformations List<RuleGroupTextTransformation>
searchString String
searchStringBase64 String

fieldToMatch RuleGroupFieldToMatch
positionalConstraint RuleGroupPositionalConstraint
textTransformations RuleGroupTextTransformation[]
searchString string
searchStringBase64 string

field_to_match RuleGroupFieldToMatch
positional_constraint RuleGroupPositionalConstraint
text_transformations Sequence[RuleGroupTextTransformation]
search_string str
search_string_base64 str

fieldToMatch Property Map
positionalConstraint "EXACTLY" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "CONTAINS_WORD"
textTransformations List<Property Map>
searchString String
searchStringBase64 String

RuleGroupCaptchaAction, RuleGroupCaptchaActionArgs

CustomRequestHandling Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomRequestHandling

CustomRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

custom_request_handling RuleGroupCustomRequestHandling

customRequestHandling Property Map

RuleGroupCaptchaConfig, RuleGroupCaptchaConfigArgs

ImmunityTimeProperty Pulumi.AwsNative.WaFv2.Inputs.RuleGroupImmunityTimeProperty

ImmunityTimeProperty RuleGroupImmunityTimeProperty

immunityTimeProperty RuleGroupImmunityTimeProperty

immunityTimeProperty RuleGroupImmunityTimeProperty

immunity_time_property RuleGroupImmunityTimeProperty

immunityTimeProperty Property Map

RuleGroupChallengeAction, RuleGroupChallengeActionArgs

CustomRequestHandling Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomRequestHandling

CustomRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

custom_request_handling RuleGroupCustomRequestHandling

customRequestHandling Property Map

RuleGroupChallengeConfig, RuleGroupChallengeConfigArgs

ImmunityTimeProperty Pulumi.AwsNative.WaFv2.Inputs.RuleGroupImmunityTimeProperty

ImmunityTimeProperty RuleGroupImmunityTimeProperty

immunityTimeProperty RuleGroupImmunityTimeProperty

immunityTimeProperty RuleGroupImmunityTimeProperty

immunity_time_property RuleGroupImmunityTimeProperty

immunityTimeProperty Property Map

RuleGroupCookieMatchPattern, RuleGroupCookieMatchPatternArgs

All object: Inspect all parts of the web request cookies.
ExcludedCookies List<string>
IncludedCookies List<string>

All interface{}: Inspect all parts of the web request cookies.
ExcludedCookies []string
IncludedCookies []string

all Object: Inspect all parts of the web request cookies.
excludedCookies List<String>
includedCookies List<String>

all any: Inspect all parts of the web request cookies.
excludedCookies string[]
includedCookies string[]

all Any: Inspect all parts of the web request cookies.
excluded_cookies Sequence[str]
included_cookies Sequence[str]

all Any: Inspect all parts of the web request cookies.
excludedCookies List<String>
includedCookies List<String>

RuleGroupCookies, RuleGroupCookiesArgs

MatchPattern Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCookieMatchPattern
MatchScope Pulumi.AwsNative.WaFv2.RuleGroupMapMatchScope
OversizeHandling Pulumi.AwsNative.WaFv2.RuleGroupOversizeHandling

MatchPattern RuleGroupCookieMatchPattern
MatchScope RuleGroupMapMatchScope
OversizeHandling RuleGroupOversizeHandling

matchPattern RuleGroupCookieMatchPattern
matchScope RuleGroupMapMatchScope
oversizeHandling RuleGroupOversizeHandling

matchPattern RuleGroupCookieMatchPattern
matchScope RuleGroupMapMatchScope
oversizeHandling RuleGroupOversizeHandling

match_pattern RuleGroupCookieMatchPattern
match_scope RuleGroupMapMatchScope
oversize_handling RuleGroupOversizeHandling

matchPattern Property Map
matchScope "ALL" | "KEY" | "VALUE"
oversizeHandling "CONTINUE" | "MATCH" | "NO_MATCH"

RuleGroupCountAction, RuleGroupCountActionArgs

CustomRequestHandling Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomRequestHandling

CustomRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

customRequestHandling RuleGroupCustomRequestHandling

custom_request_handling RuleGroupCustomRequestHandling

customRequestHandling Property Map

RuleGroupCustomHttpHeader, RuleGroupCustomHttpHeaderArgs

Name string
Value string

Name string
Value string

name String
value String

name string
value string

name str
value str

name String
value String

RuleGroupCustomRequestHandling, RuleGroupCustomRequestHandlingArgs

InsertHeaders List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomHttpHeader>: Collection of HTTP headers.

InsertHeaders []RuleGroupCustomHttpHeader: Collection of HTTP headers.

insertHeaders List<RuleGroupCustomHttpHeader>: Collection of HTTP headers.

insertHeaders RuleGroupCustomHttpHeader[]: Collection of HTTP headers.

insert_headers Sequence[RuleGroupCustomHttpHeader]: Collection of HTTP headers.

insertHeaders List<Property Map>: Collection of HTTP headers.

RuleGroupCustomResponse, RuleGroupCustomResponseArgs

ResponseCode int
CustomResponseBodyKey string: Custom response body key.
ResponseHeaders List<Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCustomHttpHeader>: Collection of HTTP headers.

ResponseCode int
CustomResponseBodyKey string: Custom response body key.
ResponseHeaders []RuleGroupCustomHttpHeader: Collection of HTTP headers.

responseCode Integer
customResponseBodyKey String: Custom response body key.
responseHeaders List<RuleGroupCustomHttpHeader>: Collection of HTTP headers.

responseCode number
customResponseBodyKey string: Custom response body key.
responseHeaders RuleGroupCustomHttpHeader[]: Collection of HTTP headers.

response_code int
custom_response_body_key str: Custom response body key.
response_headers Sequence[RuleGroupCustomHttpHeader]: Collection of HTTP headers.

responseCode Number
customResponseBodyKey String: Custom response body key.
responseHeaders List<Property Map>: Collection of HTTP headers.

RuleGroupCustomResponseBody, RuleGroupCustomResponseBodyArgs

Content string
ContentType Pulumi.AwsNative.WaFv2.RuleGroupResponseContentType

Content string
ContentType RuleGroupResponseContentType

content String
contentType RuleGroupResponseContentType

content string
contentType RuleGroupResponseContentType

content str
content_type RuleGroupResponseContentType

content String
contentType "TEXT_PLAIN" | "TEXT_HTML" | "APPLICATION_JSON"

RuleGroupFieldToMatch, RuleGroupFieldToMatchArgs

AllQueryArguments object: All query arguments of a web request.
Body Pulumi.AwsNative.WaFv2.Inputs.RuleGroupBody
Cookies Pulumi.AwsNative.WaFv2.Inputs.RuleGroupCookies
Headers Pulumi.AwsNative.WaFv2.Inputs.RuleGroupHeaders
Ja3Fingerprint Pulumi.AwsNative.WaFv2.Inputs.RuleGroupJa3Fingerprint
JsonBody Pulumi.AwsNative.WaFv2.Inputs.RuleGroupJsonBody
Method object: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
QueryString object: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
SingleHeader Pulumi.AwsNative.WaFv2.Inputs.RuleGroupFieldToMatchSingleHeaderProperties
SingleQueryArgument Pulumi.AwsNative.WaFv2.Inputs.RuleGroupFieldToMatchSingleQueryArgumentProperties: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
UriPath object: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

AllQueryArguments interface{}: All query arguments of a web request.
Body RuleGroupBody
Cookies RuleGroupCookies
Headers RuleGroupHeaders
Ja3Fingerprint RuleGroupJa3Fingerprint
JsonBody RuleGroupJsonBody
Method interface{}: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
QueryString interface{}: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
SingleHeader RuleGroupFieldToMatchSingleHeaderProperties
SingleQueryArgument RuleGroupFieldToMatchSingleQueryArgumentProperties: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
UriPath interface{}: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

allQueryArguments Object: All query arguments of a web request.
body RuleGroupBody
cookies RuleGroupCookies
headers RuleGroupHeaders
ja3Fingerprint RuleGroupJa3Fingerprint
jsonBody RuleGroupJsonBody
method Object: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
queryString Object: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
singleHeader RuleGroupFieldToMatchSingleHeaderProperties
singleQueryArgument RuleGroupFieldToMatchSingleQueryArgumentProperties: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
uriPath Object: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

allQueryArguments any: All query arguments of a web request.
body RuleGroupBody
cookies RuleGroupCookies
headers RuleGroupHeaders
ja3Fingerprint RuleGroupJa3Fingerprint
jsonBody RuleGroupJsonBody
method any: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
queryString any: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
singleHeader RuleGroupFieldToMatchSingleHeaderProperties
singleQueryArgument RuleGroupFieldToMatchSingleQueryArgumentProperties: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
uriPath any: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

all_query_arguments Any: All query arguments of a web request.
body RuleGroupBody
cookies RuleGroupCookies
headers RuleGroupHeaders
ja3_fingerprint RuleGroupJa3Fingerprint
json_body RuleGroupJsonBody
method Any: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
query_string Any: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
single_header RuleGroupFieldToMatchSingleHeaderProperties
single_query_argument RuleGroupFieldToMatchSingleQueryArgumentProperties: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
uri_path Any: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

allQueryArguments Any: All query arguments of a web request.
body Property Map
cookies Property Map
headers Property Map
ja3Fingerprint Property Map
jsonBody Property Map
method Any: The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
queryString Any: The query string of a web request. This is the part of a URL that appears after a ? character, if any.
singleHeader Property Map
singleQueryArgument Property Map: One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
uriPath Any: The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.