Class CfnWebACL.RequestInspectionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebACL.RequestInspectionProperty>
- Enclosing interface:
CfnWebACL.RequestInspectionProperty
CfnWebACL.RequestInspectionProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.passwordField
(IResolvable passwordField) Sets the value ofCfnWebACL.RequestInspectionProperty.getPasswordField()
passwordField
(CfnWebACL.FieldIdentifierProperty passwordField) Sets the value ofCfnWebACL.RequestInspectionProperty.getPasswordField()
payloadType
(String payloadType) Sets the value ofCfnWebACL.RequestInspectionProperty.getPayloadType()
usernameField
(IResolvable usernameField) Sets the value ofCfnWebACL.RequestInspectionProperty.getUsernameField()
usernameField
(CfnWebACL.FieldIdentifierProperty usernameField) Sets the value ofCfnWebACL.RequestInspectionProperty.getUsernameField()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
passwordField
@Stability(Stable) public CfnWebACL.RequestInspectionProperty.Builder passwordField(IResolvable passwordField) Sets the value ofCfnWebACL.RequestInspectionProperty.getPasswordField()
- Parameters:
passwordField
- The name of the field in the request payload that contains your customer's password. This parameter is required. 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 ispassword1
.- Returns:
this
-
passwordField
@Stability(Stable) public CfnWebACL.RequestInspectionProperty.Builder passwordField(CfnWebACL.FieldIdentifierProperty passwordField) Sets the value ofCfnWebACL.RequestInspectionProperty.getPasswordField()
- Parameters:
passwordField
- The name of the field in the request payload that contains your customer's password. This parameter is required. 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 ispassword1
.- Returns:
this
-
payloadType
@Stability(Stable) public CfnWebACL.RequestInspectionProperty.Builder payloadType(String payloadType) Sets the value ofCfnWebACL.RequestInspectionProperty.getPayloadType()
- Parameters:
payloadType
- The payload type for your login endpoint, either JSON or form encoded. This parameter is required.- Returns:
this
-
usernameField
@Stability(Stable) public CfnWebACL.RequestInspectionProperty.Builder usernameField(IResolvable usernameField) Sets the value ofCfnWebACL.RequestInspectionProperty.getUsernameField()
- Parameters:
usernameField
- The name of the field in the request payload that contains your customer's username. This parameter is required. 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 isusername1
- Returns:
this
-
usernameField
@Stability(Stable) public CfnWebACL.RequestInspectionProperty.Builder usernameField(CfnWebACL.FieldIdentifierProperty usernameField) Sets the value ofCfnWebACL.RequestInspectionProperty.getUsernameField()
- Parameters:
usernameField
- The name of the field in the request payload that contains your customer's username. This parameter is required. 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 isusername1
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWebACL.RequestInspectionProperty>
- Returns:
- a new instance of
CfnWebACL.RequestInspectionProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-