Class: Aws::WAFV2::Types::CreateRuleGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-wafv2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity ⇒ Integer

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, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see [WAF web ACL capacity units (WCU)] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html

Returns:

  • (Integer) 


1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#custom_response_bodies ⇒ Hash<String,Types::CustomResponseBody>

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see

Customizing web requests and responses in WAF][1

in the *WAF

Developer Guide*.

For information about the limits on count and size for custom request and response settings, see [WAF quotas] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html [2]: docs.aws.amazon.com/waf/latest/developerguide/limits.html

Returns:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the rule group that helps with identification.

Returns:

  • (String) 


1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::Rule>

The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

Returns:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

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.

Returns:

  • (String) 


1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_config ⇒ Types::VisibilityConfig

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Returns:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/aws-sdk-wafv2/types.rb', line 1362

class CreateRuleGroupRequest < Struct.new(
  :name,
  :scope,
  :capacity,
  :description,
  :rules,
  :visibility_config,
  :tags,
  :custom_response_bodies)
  SENSITIVE = []
  include Aws::Structure
end