createRuleGroup method

Future<CreateRuleGroupResponse> createRuleGroup({ required int capacity, required String name, required Scope scope, required VisibilityConfig visibilityConfig, String? description, List<Rule>? rules, List<Tag>? tags, })

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

May throw WAFInternalErrorException. May throw WAFInvalidParameterException. May throw WAFDuplicateItemException. May throw WAFOptimisticLockException. May throw WAFLimitsExceededException. May throw WAFUnavailableEntityException. May throw WAFTagOperationException. May throw WAFTagOperationInternalErrorException. May throw WAFSubscriptionNotFoundException. May throw WAFNonexistentItemException. May throw WAFInvalidOperationException.

Parameter capacity : The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Parameter name : The name of the rule group. You cannot change the name of a rule group after you create it.

Parameter scope : 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.

Parameter visibilityConfig : Defines and enables Amazon CloudWatch metrics and web request sample collection.

Parameter description : A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

Parameter rules : The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

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

Implementation

Future<CreateRuleGroupResponse> createRuleGroup({
  required int capacity,
  required String name,
  required Scope scope,
  required VisibilityConfig visibilityConfig,
  String? description,
  List<Rule>? rules,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(capacity, 'capacity');
  _s.validateNumRange(
    'capacity',
    capacity,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(scope, 'scope');
  ArgumentError.checkNotNull(visibilityConfig, 'visibilityConfig');
  _s.validateStringLength(
    'description',
    description,
    1,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSWAF_20190729.CreateRuleGroup'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Capacity': capacity,
      'Name': name,
      'Scope': scope.toValue(),
      'VisibilityConfig': visibilityConfig,
      if (description != null) 'Description': description,
      if (rules != null) 'Rules': rules,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateRuleGroupResponse.fromJson(jsonResponse.body);
}