Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroupProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.wafv2.CfnRuleGroupProps.Jsii$Proxy
All Implemented Interfaces:
CfnRuleGroupProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnRuleGroupProps
@Stability(Stable) @Internal public static final class CfnRuleGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnRuleGroupProps
An implementation for CfnRuleGroupProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.wafv2.CfnRuleGroupProps

    CfnRuleGroupProps.Builder, CfnRuleGroupProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnRuleGroupProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnRuleGroupProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Object
    getAvailableLabels()
    The labels that one or more rules in this rule group add to matching web requests.
    final Number
    getCapacity()
    The web ACL capacity units (WCUs) required for this rule group.
    final Object
    getConsumedLabels()
    The labels that one or more rules in this rule group match against in label match statements.
    final Object
    getCustomResponseBodies()
    A map of custom response keys and content bodies.
    final String
    getDescription()
    A description of the rule group that helps with identification.
    final String
    getName()
    The name of the rule group.
    final Object
    getRules()
    The rule statements used to identify the web requests that you want to allow, block, or count.
    final String
    getScope()
    Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
    final List<CfnTag>
    getTags()
    Key:value pairs associated with an AWS resource.
    final Object
    getVisibilityConfig()
    Defines and enables Amazon CloudWatch metrics and web request sample collection.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnRuleGroupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnRuleGroupProps.Builder.

  • Method Details

    • getCapacity

      public final Number getCapacity()
      Description copied from interface: CfnRuleGroupProps
      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.

      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.

      Specified by:
      getCapacity in interface CfnRuleGroupProps

    • getScope

      public final String getScope()
      Description copied from interface: CfnRuleGroupProps
      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 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 .

      Specified by:
      getScope in interface CfnRuleGroupProps

    • getVisibilityConfig

      public final Object getVisibilityConfig()
      Description copied from interface: CfnRuleGroupProps
      Defines and enables Amazon CloudWatch metrics and web request sample collection.
      Specified by:
      getVisibilityConfig in interface CfnRuleGroupProps

    • getAvailableLabels

      public final Object getAvailableLabels()
      Description copied from interface: CfnRuleGroupProps
      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 .

      Specified by:
      getAvailableLabels in interface CfnRuleGroupProps

    • getConsumedLabels

      public final Object getConsumedLabels()
      Description copied from interface: CfnRuleGroupProps
      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.

      Specified by:
      getConsumedLabels in interface CfnRuleGroupProps

    • getCustomResponseBodies

      public final Object getCustomResponseBodies()
      Description copied from interface: CfnRuleGroupProps
      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 .

      Specified by:
      getCustomResponseBodies in interface CfnRuleGroupProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnRuleGroupProps
      A description of the rule group that helps with identification.
      Specified by:
      getDescription in interface CfnRuleGroupProps

    • getName

      public final String getName()
      Description copied from interface: CfnRuleGroupProps
      The name of the rule group.

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

      Specified by:
      getName in interface CfnRuleGroupProps

    • getRules

      public final Object getRules()
      Description copied from interface: CfnRuleGroupProps
      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.

      Specified by:
      getRules in interface CfnRuleGroupProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnRuleGroupProps
      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.

      Specified by:
      getTags in interface CfnRuleGroupProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object