regex_pattern_sets

Creates, updates, deletes, gets or lists a regex_pattern_sets resource.

Overview

Name	regex_pattern_sets
Type	Resource
Id	aws.wafv2.regex_pattern_sets

Fields

The following fields are returned by SELECT queries:

get_regex_pattern_set

Name	Datatype	Description
lock_token	string	A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. (pattern: <code>^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$</code>)
regex_pattern_set	object	Contains one or more regular expressions. WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

list_regex_pattern_sets

Name	Datatype	Description
next_marker	string	When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. (pattern: <code>.\S.</code>)
regex_pattern_sets	array	Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_regex_pattern_set	select	region		Retrieves the specified RegexPatternSet.
list_regex_pattern_sets	select	region		Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
create_regex_pattern_set	insert	region, Name, Scope, RegularExpressionList		Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
update_regex_pattern_set	update	region, Name, Scope, Id, RegularExpressionList, LockToken		Updates the specified RegexPatternSet. This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify a regex pattern set, do the following: Retrieve it by calling GetRegexPatternSet Update its settings as needed Provide the complete regex pattern set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. After you change a rule action setting, you might see the old action in some places and the new action in others. After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
delete_regex_pattern_set	delete	region		Deletes the specified RegexPatternSet.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_regex_pattern_set

Retrieves the specified RegexPatternSet.

SELECT
lock_token,
regex_pattern_set
FROM aws.wafv2.regex_pattern_sets
WHERE region = '{{ region }}' -- required
;

list_regex_pattern_sets

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

SELECT
next_marker,
regex_pattern_sets
FROM aws.wafv2.regex_pattern_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_regex_pattern_set

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

INSERT INTO aws.wafv2.regex_pattern_sets (
Name,
Scope,
Description,
RegularExpressionList,
Tags,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Scope }}' /* required */,
'{{ Description }}',
'{{ RegularExpressionList }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
summary
;

Manifest

# Description fields are for documentation purposes
- name: regex_pattern_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the regex_pattern_sets resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the set. You cannot change the name after you create the set.
  - name: Scope
    value: "{{ Scope }}"
    description: |
      Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT. 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.
    valid_values: ['CLOUDFRONT', 'REGIONAL']
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the set that helps with identification.
  - name: RegularExpressionList
    description: |
      Array of regular expression strings.
    value:
      - RegexString: "{{ RegexString }}"
  - name: Tags
    description: |
      An array of key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_regex_pattern_set

Updates the specified RegexPatternSet. This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify a regex pattern set, do the following: Retrieve it by calling GetRegexPatternSet Update its settings as needed Provide the complete regex pattern set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. After you change a rule action setting, you might see the old action in some places and the new action in others. After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

UPDATE aws.wafv2.regex_pattern_sets
SET 
Name = '{{ Name }}',
Scope = '{{ Scope }}',
Id = '{{ Id }}',
Description = '{{ Description }}',
RegularExpressionList = '{{ RegularExpressionList }}',
LockToken = '{{ LockToken }}'
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND Scope = '{{ Scope }}' --required
AND Id = '{{ Id }}' --required
AND RegularExpressionList = '{{ RegularExpressionList }}' --required
AND LockToken = '{{ LockToken }}' --required
RETURNING
next_lock_token;

DELETE examples

delete_regex_pattern_set

Deletes the specified RegexPatternSet.

DELETE FROM aws.wafv2.regex_pattern_sets
WHERE region = '{{ region }}' --required
;