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

Class CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • addressFields

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder addressFields(IResolvable addressFields)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getAddressFields()
      Parameters:
      addressFields - The names of the fields in the request payload that contain your customer's primary physical address. Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1 , /form/primaryaddressline2 , and /form/primaryaddressline3 .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with input elements named primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 , the address fields identifiers are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 .

      Returns:
      this

    • addressFields

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder addressFields(List<? extends Object> addressFields)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getAddressFields()
      Parameters:
      addressFields - The names of the fields in the request payload that contain your customer's primary physical address. Order the address fields in the array exactly as they are ordered in the request payload.

      How you specify the address fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1 , /form/primaryaddressline2 , and /form/primaryaddressline3 .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with input elements named primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 , the address fields identifiers are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 .

      Returns:
      this

    • emailField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder emailField(IResolvable emailField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getEmailField()
      Parameters:
      emailField - The name of the field in the request payload that contains your customer's email. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "email": "THE_EMAIL" } } , the email field specification is /form/email .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named email1 , the email field specification is email1 .

      Returns:
      this

    • emailField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder emailField(CfnWebACLPropsMixin.FieldIdentifierProperty emailField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getEmailField()
      Parameters:
      emailField - The name of the field in the request payload that contains your customer's email. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "email": "THE_EMAIL" } } , the email field specification is /form/email .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named email1 , the email field specification is email1 .

      Returns:
      this

    • passwordField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder passwordField(IResolvable passwordField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getPasswordField()
      Parameters:
      passwordField - The name of the field in the request payload that contains your customer's password. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , the password field specification is /form/password .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named password1 , the password field specification is password1 .

      Returns:
      this

    • passwordField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder passwordField(CfnWebACLPropsMixin.FieldIdentifierProperty passwordField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getPasswordField()
      Parameters:
      passwordField - The name of the field in the request payload that contains your customer's password. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , the password field specification is /form/password .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named password1 , the password field specification is password1 .

      Returns:
      this

    • payloadType

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder payloadType(String payloadType)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getPayloadType()
      Parameters:
      payloadType - The payload type for your account creation endpoint, either JSON or form encoded.
      Returns:
      this

    • phoneNumberFields

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder phoneNumberFields(IResolvable phoneNumberFields)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getPhoneNumberFields()
      Parameters:
      phoneNumberFields - The names of the fields in the request payload that contain your customer's primary phone number. Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1 , /form/primaryphoneline2 , and /form/primaryphoneline3 .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 .

      Returns:
      this

    • phoneNumberFields

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder phoneNumberFields(List<? extends Object> phoneNumberFields)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getPhoneNumberFields()
      Parameters:
      phoneNumberFields - The names of the fields in the request payload that contain your customer's primary phone number. Order the phone number fields in the array exactly as they are ordered in the request payload.

      How you specify the phone number fields depends on the request inspection payload type.

      • For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1 , /form/primaryphoneline2 , and /form/primaryphoneline3 .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 .

      Returns:
      this

    • usernameField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder usernameField(IResolvable usernameField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getUsernameField()
      Parameters:
      usernameField - The name of the field in the request payload that contains your customer's username. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , the username field specification is /form/username .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named username1 , the username field specification is username1

      Returns:
      this

    • usernameField

      @Stability(Stable) public CfnWebACLPropsMixin.RequestInspectionACFPProperty.Builder usernameField(CfnWebACLPropsMixin.FieldIdentifierProperty usernameField)
      Sets the value of CfnWebACLPropsMixin.RequestInspectionACFPProperty.getUsernameField()
      Parameters:
      usernameField - The name of the field in the request payload that contains your customer's username. How you specify this depends on the request inspection payload type.

      • For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

      For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , the username field specification is /form/username .

      • For form encoded payload types, use the HTML form names.

      For example, for an HTML form with the input element named username1 , the username field specification is username1

      Returns:
      this

    • build

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