1. Packages
  2. AWS Native
  3. API Docs
  4. wafv2
  5. getRuleGroup

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

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

aws-native.wafv2.getRuleGroup

Explore with Pulumi AI

aws-native logo

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

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

    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.

    Using getRuleGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRuleGroup(args: GetRuleGroupArgs, opts?: InvokeOptions): Promise<GetRuleGroupResult>
    function getRuleGroupOutput(args: GetRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetRuleGroupResult>
    def get_rule_group(id: Optional[str] = None,
                       name: Optional[str] = None,
                       scope: Optional[RuleGroupScope] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRuleGroupResult
    def get_rule_group_output(id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       scope: Optional[pulumi.Input[RuleGroupScope]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRuleGroupResult]
    func LookupRuleGroup(ctx *Context, args *LookupRuleGroupArgs, opts ...InvokeOption) (*LookupRuleGroupResult, error)
    func LookupRuleGroupOutput(ctx *Context, args *LookupRuleGroupOutputArgs, opts ...InvokeOption) LookupRuleGroupResultOutput

    > Note: This function is named LookupRuleGroup in the Go SDK.

    public static class GetRuleGroup 
    {
        public static Task<GetRuleGroupResult> InvokeAsync(GetRuleGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetRuleGroupResult> Invoke(GetRuleGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRuleGroupResult> getRuleGroup(GetRuleGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:wafv2:getRuleGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getRuleGroup Result

    The following output properties are available:

    Arn string
    AvailableLabels []RuleGroupLabelSummary
    Collection of Available Labels.
    Capacity int
    ConsumedLabels []RuleGroupLabelSummary
    Collection of Consumed Labels.
    CustomResponseBodies map[string]RuleGroupCustomResponseBody
    Description string
    Id string
    LabelNamespace string
    Rules []RuleGroupRule
    Collection of Rules.
    Tags Tag
    VisibilityConfig RuleGroupVisibilityConfig
    arn String
    availableLabels List<RuleGroupLabelSummary>
    Collection of Available Labels.
    capacity Integer
    consumedLabels List<RuleGroupLabelSummary>
    Collection of Consumed Labels.
    customResponseBodies Map<String,RuleGroupCustomResponseBody>
    description String
    id String
    labelNamespace String
    rules List<RuleGroupRule>
    Collection of Rules.
    tags List<Tag>
    visibilityConfig RuleGroupVisibilityConfig
    arn string
    availableLabels RuleGroupLabelSummary[]
    Collection of Available Labels.
    capacity number
    consumedLabels RuleGroupLabelSummary[]
    Collection of Consumed Labels.
    customResponseBodies {[key: string]: RuleGroupCustomResponseBody}
    description string
    id string
    labelNamespace string
    rules RuleGroupRule[]
    Collection of Rules.
    tags Tag[]
    visibilityConfig RuleGroupVisibilityConfig
    arn String
    availableLabels List<Property Map>
    Collection of Available Labels.
    capacity Number
    consumedLabels List<Property Map>
    Collection of Consumed Labels.
    customResponseBodies Map<Property Map>
    description String
    id String
    labelNamespace String
    rules List<Property Map>
    Collection of Rules.
    tags List<Property Map>
    visibilityConfig Property Map

    Supporting Types

    RuleGroupAllowAction

    RuleGroupAndStatement

    RuleGroupBlockAction

    RuleGroupBody

    RuleGroupBodyParsingFallbackBehavior

    RuleGroupByteMatchStatement

    RuleGroupCaptchaAction

    RuleGroupCaptchaConfig

    RuleGroupChallengeAction

    RuleGroupChallengeConfig

    RuleGroupCookieMatchPattern

    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

    RuleGroupCountAction

    RuleGroupCustomHttpHeader

    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

    InsertHeaders []RuleGroupCustomHttpHeader
    Collection of HTTP headers.
    insertHeaders RuleGroupCustomHttpHeader[]
    Collection of HTTP headers.
    insertHeaders List<Property Map>
    Collection of HTTP headers.

    RuleGroupCustomResponse

    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

    RuleGroupFieldToMatch

    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.

    RuleGroupFieldToMatchSingleHeaderProperties

    Name string
    Name string
    name String
    name string
    name str
    name String

    RuleGroupFieldToMatchSingleQueryArgumentProperties

    Name string
    Name string
    name String
    name string
    name str
    name String

    RuleGroupForwardedIpConfiguration

    RuleGroupForwardedIpConfigurationFallbackBehavior

    RuleGroupGeoMatchStatement

    RuleGroupHeaderMatchPattern

    All object
    Inspect all parts of the web request headers.
    ExcludedHeaders List<string>
    IncludedHeaders List<string>
    All interface{}
    Inspect all parts of the web request headers.
    ExcludedHeaders []string
    IncludedHeaders []string
    all Object
    Inspect all parts of the web request headers.
    excludedHeaders List<String>
    includedHeaders List<String>
    all any
    Inspect all parts of the web request headers.
    excludedHeaders string[]
    includedHeaders string[]
    all Any
    Inspect all parts of the web request headers.
    excluded_headers Sequence[str]
    included_headers Sequence[str]
    all Any
    Inspect all parts of the web request headers.
    excludedHeaders List<String>
    includedHeaders List<String>

    RuleGroupHeaders

    RuleGroupImmunityTimeProperty

    immunityTime Integer

    RuleGroupIpSetForwardedIpConfiguration

    RuleGroupIpSetForwardedIpConfigurationFallbackBehavior

    RuleGroupIpSetForwardedIpConfigurationPosition

    RuleGroupIpSetReferenceStatement

    RuleGroupJa3Fingerprint

    RuleGroupJa3FingerprintFallbackBehavior

    RuleGroupJsonBody

    RuleGroupJsonMatchPattern

    All object
    Inspect all parts of the web request's JSON body.
    IncludedPaths List<string>
    All interface{}
    Inspect all parts of the web request's JSON body.
    IncludedPaths []string
    all Object
    Inspect all parts of the web request's JSON body.
    includedPaths List<String>
    all any
    Inspect all parts of the web request's JSON body.
    includedPaths string[]
    all Any
    Inspect all parts of the web request's JSON body.
    included_paths Sequence[str]
    all Any
    Inspect all parts of the web request's JSON body.
    includedPaths List<String>

    RuleGroupJsonMatchScope

    RuleGroupLabel

    Name string
    Name string
    name String
    name string
    name str
    name String

    RuleGroupLabelMatchScope

    RuleGroupLabelMatchStatement

    RuleGroupLabelSummary

    Name string
    Name string
    name String
    name string
    name str
    name String

    RuleGroupMapMatchScope

    RuleGroupNotStatement

    RuleGroupOrStatement

    RuleGroupOversizeHandling

    RuleGroupPositionalConstraint

    RuleGroupRateBasedStatement

    RuleGroupRateBasedStatementAggregateKeyType

    RuleGroupRateBasedStatementCustomKey

    RuleGroupRateLimitCookie

    Name string
    The name of the cookie to use.
    TextTransformations []RuleGroupTextTransformation
    name String
    The name of the cookie to use.
    textTransformations List<RuleGroupTextTransformation>
    name string
    The name of the cookie to use.
    textTransformations RuleGroupTextTransformation[]
    name String
    The name of the cookie to use.
    textTransformations List<Property Map>

    RuleGroupRateLimitHeader

    Name string
    The name of the header to use.
    TextTransformations []RuleGroupTextTransformation
    name String
    The name of the header to use.
    textTransformations List<RuleGroupTextTransformation>
    name string
    The name of the header to use.
    textTransformations RuleGroupTextTransformation[]
    name String
    The name of the header to use.
    textTransformations List<Property Map>

    RuleGroupRateLimitLabelNamespace

    Namespace string
    The namespace to use for aggregation.
    Namespace string
    The namespace to use for aggregation.
    namespace String
    The namespace to use for aggregation.
    namespace string
    The namespace to use for aggregation.
    namespace str
    The namespace to use for aggregation.
    namespace String
    The namespace to use for aggregation.

    RuleGroupRateLimitQueryArgument

    Name string
    The name of the query argument to use.
    TextTransformations []RuleGroupTextTransformation
    name String
    The name of the query argument to use.
    textTransformations List<RuleGroupTextTransformation>
    name string
    The name of the query argument to use.
    textTransformations RuleGroupTextTransformation[]
    name str
    The name of the query argument to use.
    text_transformations Sequence[RuleGroupTextTransformation]
    name String
    The name of the query argument to use.
    textTransformations List<Property Map>

    RuleGroupRateLimitQueryString

    RuleGroupRateLimitUriPath

    RuleGroupRegexMatchStatement

    RuleGroupRegexPatternSetReferenceStatement

    RuleGroupResponseContentType

    RuleGroupRule

    RuleGroupRuleAction

    RuleGroupScope

    RuleGroupSensitivityLevel

    RuleGroupSizeConstraintStatement

    RuleGroupSizeConstraintStatementComparisonOperator

    RuleGroupSqliMatchStatement

    RuleGroupStatement

    AndStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupAndStatement
    ByteMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupByteMatchStatement
    GeoMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupGeoMatchStatement
    IpSetReferenceStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupIpSetReferenceStatement
    LabelMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupLabelMatchStatement
    NotStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupNotStatement
    OrStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupOrStatement
    RateBasedStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupRateBasedStatement
    RegexMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupRegexMatchStatement
    RegexPatternSetReferenceStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupRegexPatternSetReferenceStatement
    SizeConstraintStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupSizeConstraintStatement
    SqliMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupSqliMatchStatement
    XssMatchStatement Pulumi.AwsNative.WaFv2.Inputs.RuleGroupXssMatchStatement

    RuleGroupTextTransformation

    RuleGroupTextTransformationType

    RuleGroupVisibilityConfig

    RuleGroupXssMatchStatement

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

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

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