You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFV2::Types::CreateRegexPatternSetRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateRegexPatternSetRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "EntityName", # required
  scope: "CLOUDFRONT", # required, accepts CLOUDFRONT, REGIONAL
  description: "EntityDescription",
  regular_expression_list: [ # required
    {
      regex_string: "RegexPatternString",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the set that helps with identification. You cannot change the description of a set after you create it.

Returns:

  • (String)

    A description of the set that helps with identification.

#nameString

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

Returns:

  • (String)

    The name of the set.

#regular_expression_listArray<Types::Regex>

Array of regular expression strings.

Returns:

  • (Array<Types::Regex>)

    Array of regular expression strings.

#scopeString

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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.

    Possible values:

    • CLOUDFRONT
    • REGIONAL

Returns:

  • (String)

    Specifies whether this is for an AWS CloudFront distribution or for a regional application.

#tagsArray<Types::Tag>

An array of key:value pairs to associate with the resource.

Returns:

  • (Array<Types::Tag>)

    An array of key:value pairs to associate with the resource.