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

Class UpdateRuleGroupRequest

    • Method Detail

      • name

        public final String name()

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

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

      • scope

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

        Returns:
        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.

        See Also:
        Scope

      • scopeAsString

        public final String scopeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

        Returns:
        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.

        See Also:
        Scope

      • id

        public final String id()

        A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        Returns:
        A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • description

        public final String description()

        A description of the rule group that helps with identification.

        Returns:
        A description of the rule group that helps with identification.

      • hasRules

        public final boolean hasRules()
        For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • rules

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRules() method.

        Returns:
        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.

      • visibilityConfig

        public final VisibilityConfig visibilityConfig()

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

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

      • lockToken

        public final String lockToken()

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

        Returns:
        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      • hasCustomResponseBodies

        public final boolean hasCustomResponseBodies()
        For responses, this returns true if the service returned a value for the CustomResponseBodies property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • customResponseBodies

        public final 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomResponseBodies() method.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object