Skip to content

Get Regex Pattern Set

wafv2_get_regex_pattern_set R Documentation

Retrieves the specified RegexPatternSet

Description

Retrieves the specified RegexPatternSet.

Usage

wafv2_get_regex_pattern_set(Name, Scope, Id)

Arguments

Name

[required] The name of the set. You cannot change the name after you create the set.

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 set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Value

A list with the following syntax: 

list(
  RegexPatternSet = list(
    Name = "string",
    Id = "string",
    ARN = "string",
    Description = "string",
    RegularExpressionList = list(
      list(
        RegexString = "string"
      )
    )
  ),
  LockToken = "string"
)

Request syntax

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