Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.FieldToMatchProperty>
Enclosing interface:
CfnRuleGroupPropsMixin.FieldToMatchProperty
@Stability(Stable) public static final class CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.FieldToMatchProperty>
A builder for CfnRuleGroupPropsMixin.FieldToMatchProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allQueryArguments

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder allQueryArguments(Object allQueryArguments)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getAllQueryArguments()
      Parameters:
      allQueryArguments - Inspect all query arguments.
      Returns:
      this

    • body

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder body(IResolvable body)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getBody()
      Parameters:
      body - Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

      AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

      • For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.
      • For AWS Amplify , use the CloudFront limit.

      For information about how to handle oversized request bodies, see the Body object configuration.

      Returns:
      this

    • body

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder body(CfnRuleGroupPropsMixin.BodyProperty body)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getBody()
      Parameters:
      body - Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

      AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

      • For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.
      • For AWS Amplify , use the CloudFront limit.

      For information about how to handle oversized request bodies, see the Body object configuration.

      Returns:
      this

    • cookies

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder cookies(IResolvable cookies)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getCookies()
      Parameters:
      cookies - Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

      Returns:
      this

    • cookies

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder cookies(CfnRuleGroupPropsMixin.CookiesProperty cookies)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getCookies()
      Parameters:
      cookies - Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

      Returns:
      this

    • headerOrder

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder headerOrder(IResolvable headerOrder)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getHeaderOrder()
      Parameters:
      headerOrder - The string containing the list of a web request's header names, ordered as they appear in the web request, separated by colons.
      Returns:
      this

    • headerOrder

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder headerOrder(CfnRuleGroupPropsMixin.HeaderOrderProperty headerOrder)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getHeaderOrder()
      Parameters:
      headerOrder - The string containing the list of a web request's header names, ordered as they appear in the web request, separated by colons.
      Returns:
      this

    • headers

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder headers(IResolvable headers)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getHeaders()
      Parameters:
      headers - Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

      Returns:
      this

    • headers

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder headers(CfnRuleGroupPropsMixin.HeadersProperty headers)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getHeaders()
      Parameters:
      headers - Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

      Returns:
      this

    • ja3Fingerprint

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder ja3Fingerprint(IResolvable ja3Fingerprint)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJa3Fingerprint()
      Parameters:
      ja3Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

      You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY .

      You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .

      Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

      Returns:
      this

    • ja3Fingerprint

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder ja3Fingerprint(CfnRuleGroupPropsMixin.JA3FingerprintProperty ja3Fingerprint)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJa3Fingerprint()
      Parameters:
      ja3Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

      You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY .

      You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .

      Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

      Returns:
      this

    • ja4Fingerprint

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder ja4Fingerprint(IResolvable ja4Fingerprint)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJa4Fingerprint()
      Parameters:
      ja4Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

      You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY .

      You can obtain the JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .

      Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

      Returns:
      this

    • ja4Fingerprint

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder ja4Fingerprint(CfnRuleGroupPropsMixin.JA4FingerprintProperty ja4Fingerprint)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJa4Fingerprint()
      Parameters:
      ja4Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. AWS WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.

      You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY .

      You can obtain the JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the AWS WAF Developer Guide .

      Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

      Returns:
      this

    • jsonBody

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder jsonBody(IResolvable jsonBody)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJsonBody()
      Parameters:
      jsonBody - Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

      AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

      • For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.
      • For AWS Amplify , use the CloudFront limit.

      For information about how to handle oversized request bodies, see the JsonBody object configuration.

      Returns:
      this

    • jsonBody

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder jsonBody(CfnRuleGroupPropsMixin.JsonBodyProperty jsonBody)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getJsonBody()
      Parameters:
      jsonBody - Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

      AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection.

      • For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
      • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig , for additional processing fees.
      • For AWS Amplify , use the CloudFront limit.

      For information about how to handle oversized request bodies, see the JsonBody object configuration.

      Returns:
      this

    • method

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder method(Object method)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getMethod()
      Parameters:
      method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
      Returns:
      this

    • queryString

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder queryString(Object queryString)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getQueryString()
      Parameters:
      queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if any.
      Returns:
      this

    • singleHeader

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder singleHeader(Object singleHeader)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getSingleHeader()
      Parameters:
      singleHeader - Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

      Example JSON: "SingleHeader": { "Name": "haystack" }

      Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

      Returns:
      this

    • singleQueryArgument

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder singleQueryArgument(Object singleQueryArgument)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getSingleQueryArgument()
      Parameters:
      singleQueryArgument - Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

      Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

      Returns:
      this

    • uriFragment

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder uriFragment(IResolvable uriFragment)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getUriFragment()
      Parameters:
      uriFragment - Inspect fragments of the request URI. You must configure scope and pattern matching filters in the UriFragment object, to define the fragment of a URI that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the UriFragment object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

      Returns:
      this

    • uriFragment

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder uriFragment(CfnRuleGroupPropsMixin.UriFragmentProperty uriFragment)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getUriFragment()
      Parameters:
      uriFragment - Inspect fragments of the request URI. You must configure scope and pattern matching filters in the UriFragment object, to define the fragment of a URI that AWS WAF inspects.

      Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the UriFragment object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

      Returns:
      this

    • uriPath

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty.Builder uriPath(Object uriPath)
      Sets the value of CfnRuleGroupPropsMixin.FieldToMatchProperty.getUriPath()
      Parameters:
      uriPath - Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg .
      Returns:
      this

    • build

      @Stability(Stable) public CfnRuleGroupPropsMixin.FieldToMatchProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.FieldToMatchProperty>
      Returns:
      a new instance of CfnRuleGroupPropsMixin.FieldToMatchProperty
      Throws:
      NullPointerException - if any required attribute was not provided