Skip to content

Get Managed Rule Set

wafv2_get_managed_rule_set R Documentation

Retrieves the specified managed rule set

Description

Retrieves the specified managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are list_managed_rule_sets, get_managed_rule_set, put_managed_rule_set_versions, and update_managed_rule_set_version_expiry_date.

Usage

wafv2_get_managed_rule_set(Name, Scope, Id)

Arguments

Name

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

This name is assigned to the corresponding managed rule group, which your customers can access and use.

Scope

[required] Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

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.

Id

[required] A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

Value

A list with the following syntax: 

list(
  ManagedRuleSet = list(
    Name = "string",
    Id = "string",
    ARN = "string",
    Description = "string",
    PublishedVersions = list(
      list(
        AssociatedRuleGroupArn = "string",
        Capacity = 123,
        ForecastedLifetime = 123,
        PublishTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        LastUpdateTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        ExpiryTimestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    RecommendedVersion = "string",
    LabelNamespace = "string"
  ),
  LockToken = "string"
)

Request syntax

svc$get_managed_rule_set(
  Name = "string",
  Scope = "CLOUDFRONT"|"REGIONAL",
  Id = "string"
)