Package software.amazon.awssdk.services.wafv2.model

Interface CreateRuleGroupRequest.Builder

    • Method Detail

      • name

        CreateRuleGroupRequest.Builder name​(String name)

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

        Parameters:
        name - The name of the rule group. You cannot change the name of a rule group after you create it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scope

        CreateRuleGroupRequest.Builder scope​(String scope)

        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.

        Parameters:
        scope - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Scope, Scope

      • scope

        CreateRuleGroupRequest.Builder scope​(Scope scope)

        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.

        Parameters:
        scope - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Scope, Scope

      • capacity

        CreateRuleGroupRequest.Builder capacity​(Long 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, 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.

        Parameters:
        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, 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateRuleGroupRequest.Builder description​(String description)

        A description of the rule group that helps with identification.

        Parameters:
        description - A description of the rule group that helps with identification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rules

        CreateRuleGroupRequest.Builder rules​(Collection<Rule> rules)

        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.

        Parameters:
        rules - 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:
        Returns a reference to this object so that method calls can be chained together.

      • rules

        CreateRuleGroupRequest.Builder rules​(Rule... rules)

        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.

        Parameters:
        rules - 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:
        Returns a reference to this object so that method calls can be chained together.

      • rules

        CreateRuleGroupRequest.Builder rules​(Consumer<Rule.Builder>... rules)

        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.

        This is a convenience method that creates an instance of the Rule.Builder avoiding the need to create one manually via Rule.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #rules(List).

        Parameters:
        rules - a consumer that will call methods on Rule.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #rules(java.util.Collection)

      • visibilityConfig

        CreateRuleGroupRequest.Builder visibilityConfig​(VisibilityConfig visibilityConfig)

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

        Parameters:
        visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateRuleGroupRequest.Builder tags​(Collection<Tag> tags)

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

        Parameters:
        tags - An array of key:value pairs to associate with the resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateRuleGroupRequest.Builder tags​(Tag... tags)

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

        Parameters:
        tags - An array of key:value pairs to associate with the resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateRuleGroupRequest.Builder tags​(Consumer<Tag.Builder>... tags)

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • customResponseBodies

        CreateRuleGroupRequest.Builder customResponseBodies​(Map<String,​CustomResponseBody> 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 WAF 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.

        Parameters:
        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 WAF 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.