WAFV2 / Client / create_regex_pattern_set

create_regex_pattern_set#

WAFV2.Client.create_regex_pattern_set(**kwargs)#

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

Request Syntax

response = client.create_regex_pattern_set(
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    Description='string',
    RegularExpressionList=[
        {
            'RegexString': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Name (string) –
[REQUIRED]

The name of the set. You cannot change the name after you create the set.
Scope (string) –
[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.
Description (string) – A description of the set that helps with identification.
RegularExpressionList (list) –
[REQUIRED]

Array of regular expression strings.
- (dict) –
  
  A single regular expression. This is used in a RegexPatternSet.
  - RegexString (string) –
    
    The string representing the regular expression.
Tags (list) –
An array of key:value pairs to associate with the resource.
- (dict) –
  
  A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as “environment”, and the tag value represents a specific value within that category, such as “test,” “development,” or “production”. Or you might set the tag key to “customer” and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
  
  You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can’t manage or view tags through the WAF console.
  - Key (string) – [REQUIRED]
    
    Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.
  - Value (string) – [REQUIRED]
    
    Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'Summary': {
        'Name': 'string',
        'Id': 'string',
        'Description': 'string',
        'LockToken': 'string',
        'ARN': 'string'
    }
}

Response Structure

(dict) –
- Summary (dict) –
  
  High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
  - Name (string) –
    
    The name of the data type instance. You cannot change the name after you create the instance.
  - Id (string) –
    
    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.
  - Description (string) –
    
    A description of the set that helps with identification.
  - LockToken (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.
  - ARN (string) –
    
    The Amazon Resource Name (ARN) of the entity.

Exceptions

WAFV2.Client.exceptions.WAFInternalErrorException
WAFV2.Client.exceptions.WAFInvalidParameterException
WAFV2.Client.exceptions.WAFDuplicateItemException
WAFV2.Client.exceptions.WAFOptimisticLockException
WAFV2.Client.exceptions.WAFLimitsExceededException
WAFV2.Client.exceptions.WAFTagOperationException
WAFV2.Client.exceptions.WAFTagOperationInternalErrorException
WAFV2.Client.exceptions.WAFInvalidOperationException