regex_pattern_set#

State module for managing Amazon WAFv2 Regex Pattern Set.

async idem_aws.states.aws.wafv2.regex_pattern_set.present(hub, ctx, name: str, scope: str, regular_expression_list: List[Regex], resource_id: str = None, description: str = None, tags: Dict[str, str] = None) → Dict[str, Any][source]#

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

Parameters:

  • name (str) – The name of the set. You cannot change the name after you create the set.

  • resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None.

  • scope (str) – 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, 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.

  • description (str, Optional) – A description of the set that helps with identification. Defaults to None.

  • regular_expression_list (list) – Array of regular expression strings. * RegexString (str, Optional): The string representing the regular expression.

  • tags (dict, Optional) – Dict in the format of {tag-key: tag-value}

Request Syntax:
[regex-pattern-resource-id]:
    aws.wafv2.regex_pattern_set.present:
      - name: "string"
      - scope: "string"
      - regular_expression_list:
          - RegexString: "string"
      - tags:
          scope: "string"
          name: "string"
Returns:

Dict[str, Any]

Examples

regex_pattern_set_name:
  aws.wafv2.regex_pattern_set.present:
    - name: regex_pattern_set_name
    - scope: CLOUDFRONT
    - regular_expression_list:
        - RegexString: "idem-aws/$+"
    - tags:
        scope: cloudfront-1
        name: regex_pattern_set_name
async idem_aws.states.aws.wafv2.regex_pattern_set.absent(hub, ctx, name: str, scope: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the specified RegexPatternSet.

Parameters:

  • name (str) – The name of the set. You cannot change the name after you create the set.

  • resource_id (str, Optional) – 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. Idem automatically considers this resource being absent if this field is not specified. Defaults to None.

  • scope (str) – 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, 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.

Request Syntax:
[regex-pattern-resource-id]:
    aws.wafv2.regex_pattern_set.absent:
      - name: "string"
      - scope: "string"
      - resource_id: "string"
Returns:

Dict[str, Any]

Examples

regex_pattern_set_name:
  aws.wafv2.regex_pattern_set.absent:
    - name: regex_pattern_set_name
    - resource_id: value
    - scope: CLOUDFRONT
async idem_aws.states.aws.wafv2.regex_pattern_set.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#
Describe the resource in a way that can be recreated/managed with the

corresponding “present” function

Returns:

Dict[str, Any]

Examples

$ idem describe aws.wafv2.regex_pattern_set