Describe Managed Rule Group

wafv2_describe_managed_rule_group

R Documentation

Provides high-level information for a managed rule group, including descriptions of the rules

Description

Provides high-level information for a managed rule group, including descriptions of the rules.

Usage

wafv2_describe_managed_rule_group(VendorName, Name, Scope, VersionName)

Arguments

VendorName

[required] The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

Name

[required] The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Scope

[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

VersionName

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.

Value

A list with the following syntax:

list(
  VersionName = "string",
  SnsTopicArn = "string",
  Capacity = 123,
  Rules = list(
    list(
      Name = "string",
      Action = list(
        Block = list(
          CustomResponse = list(
            ResponseCode = 123,
            CustomResponseBodyKey = "string",
            ResponseHeaders = list(
              list(
                Name = "string",
                Value = "string"
              )
            )
          )
        ),
        Allow = list(
          CustomRequestHandling = list(
            InsertHeaders = list(
              list(
                Name = "string",
                Value = "string"
              )
            )
          )
        ),
        Count = list(
          CustomRequestHandling = list(
            InsertHeaders = list(
              list(
                Name = "string",
                Value = "string"
              )
            )
          )
        ),
        Captcha = list(
          CustomRequestHandling = list(
            InsertHeaders = list(
              list(
                Name = "string",
                Value = "string"
              )
            )
          )
        ),
        Challenge = list(
          CustomRequestHandling = list(
            InsertHeaders = list(
              list(
                Name = "string",
                Value = "string"
              )
            )
          )
        )
      )
    )
  ),
  LabelNamespace = "string",
  AvailableLabels = list(
    list(
      Name = "string"
    )
  ),
  ConsumedLabels = list(
    list(
      Name = "string"
    )
  )
)

Request syntax

svc$describe_managed_rule_group(
  VendorName = "string",
  Name = "string",
  Scope = "CLOUDFRONT"|"REGIONAL",
  VersionName = "string"
)