public static final class CfnRuleGroupProps.Builder
extends java.lang.Object
CfnRuleGroupProps| Constructor and Description |
|---|
Builder() |
public CfnRuleGroupProps.Builder capacity(java.lang.Number capacity)
CfnRuleGroupProps.getCapacity()capacity - The web ACL capacity units (WCUs) required for this rule group. This parameter is required.
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.
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.
thispublic CfnRuleGroupProps.Builder scope(java.lang.String scope)
CfnRuleGroupProps.getScope()scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. This parameter is required.
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT and REGIONAL .
For
CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1.
thispublic CfnRuleGroupProps.Builder visibilityConfig(IResolvable visibilityConfig)
CfnRuleGroupProps.getVisibilityConfig()visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.thispublic CfnRuleGroupProps.Builder visibilityConfig(CfnRuleGroup.VisibilityConfigProperty visibilityConfig)
CfnRuleGroupProps.getVisibilityConfig()visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.thispublic CfnRuleGroupProps.Builder availableLabels(IResolvable availableLabels)
CfnRuleGroupProps.getAvailableLabels()availableLabels - The labels that one or more rules in this rule group add to matching web requests.
These labels are defined in the RuleLabels for a Rule .thispublic CfnRuleGroupProps.Builder availableLabels(java.util.List<? extends java.lang.Object> availableLabels)
CfnRuleGroupProps.getAvailableLabels()availableLabels - The labels that one or more rules in this rule group add to matching web requests.
These labels are defined in the RuleLabels for a Rule .thispublic CfnRuleGroupProps.Builder consumedLabels(IResolvable consumedLabels)
CfnRuleGroupProps.getConsumedLabels()consumedLabels - The labels that one or more rules in this rule group match against in label match statements.
These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.thispublic CfnRuleGroupProps.Builder consumedLabels(java.util.List<? extends java.lang.Object> consumedLabels)
CfnRuleGroupProps.getConsumedLabels()consumedLabels - The labels that one or more rules in this rule group match against in label match statements.
These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.thispublic CfnRuleGroupProps.Builder customResponseBodies(IResolvable customResponseBodies)
CfnRuleGroupProps.getCustomResponseBodies()customResponseBodies - 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 AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
thispublic CfnRuleGroupProps.Builder customResponseBodies(java.util.Map<java.lang.String,? extends java.lang.Object> customResponseBodies)
CfnRuleGroupProps.getCustomResponseBodies()customResponseBodies - 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 AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
thispublic CfnRuleGroupProps.Builder description(java.lang.String description)
CfnRuleGroupProps.getDescription()description - A description of the rule group that helps with identification.thispublic CfnRuleGroupProps.Builder name(java.lang.String name)
CfnRuleGroupProps.getName()name - The name of the rule group.
You cannot change the name of a rule group after you create it.thispublic CfnRuleGroupProps.Builder rules(IResolvable rules)
CfnRuleGroupProps.getRules()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.thispublic CfnRuleGroupProps.Builder rules(java.util.List<? extends java.lang.Object> rules)
CfnRuleGroupProps.getRules()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.thispublic CfnRuleGroupProps.Builder tags(java.util.List<? extends CfnTag> tags)
CfnRuleGroupProps.getTags()tags - Key:value pairs associated with an AWS resource.
The key:value pair can be anything you define. 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"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
thispublic CfnRuleGroupProps build()
CfnRuleGroupPropsjava.lang.NullPointerException - if any required attribute was not provided