com.oracle.bmc.waas.model

Class CreateCustomProtectionRuleDetails.Builder

java.lang.Object

com.oracle.bmc.waas.model.CreateCustomProtectionRuleDetails.Builder

Enclosing class:

CreateCustomProtectionRuleDetails

public static class CreateCustomProtectionRuleDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateCustomProtectionRuleDetails	build()
CreateCustomProtectionRuleDetails.Builder	compartmentId(String compartmentId) The OCID of the compartment in which to create the custom protection rule.
CreateCustomProtectionRuleDetails.Builder	copy(CreateCustomProtectionRuleDetails model)
CreateCustomProtectionRuleDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
CreateCustomProtectionRuleDetails.Builder	description(String description) A description for the Custom Protection rule.
CreateCustomProtectionRuleDetails.Builder	displayName(String displayName) A user-friendly name for the custom protection rule.
CreateCustomProtectionRuleDetails.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
CreateCustomProtectionRuleDetails.Builder	template(String template) The template text of the custom protection rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public CreateCustomProtectionRuleDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to create the custom protection rule.

Parameters:

compartmentId - the value to set

Returns:

this builder

displayName

public CreateCustomProtectionRuleDetails.Builder displayName(String displayName)

A user-friendly name for the custom protection rule.

Parameters:

displayName - the value to set

Returns:

this builder

description

public CreateCustomProtectionRuleDetails.Builder description(String description)

A description for the Custom Protection rule.

Parameters:

description - the value to set

Returns:

this builder

template

public CreateCustomProtectionRuleDetails.Builder template(String template)

The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.

Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.

id: {{id_1}} - This field is populated with a unique rule ID generated by the WAF service which identifies a SecRule. More than one SecRule can be defined in the template field of a CreateCustomSecurityRule call. The value of the first SecRule must be id: {{id_1}} and the id field of each subsequent SecRule should increase by one, as shown in the example.

ctl:ruleEngine={{mode}} - The action to be taken when the criteria of the SecRule are met, either OFF, DETECT or BLOCK. This field is automatically populated with the corresponding value of the action field of the CustomProtectionRuleSetting schema when the WafConfig is updated.

Example:* SecRule REQUEST_COOKIES "regex matching SQL injection - part 1/2" \\ "phase:2, \\ msg:'Detects chained SQL injection attempts 1/2.', \\ id: {{id_1}}, \\ ctl:ruleEngine={{mode}}, \\ deny" SecRule REQUEST_COOKIES "regex matching SQL injection - part 2/2" \\ "phase:2, \\ msg:'Detects chained SQL injection attempts 2/2.', \\ id: {{id_2}}, \\ ctl:ruleEngine={{mode}}, \\ deny"

The example contains two SecRules each having distinct regex expression to match the Cookie header value during the second input analysis phase.

For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/Content/WAF/Tasks/customprotectionrules.htm).

For more information about ModSecurity syntax, see [Making Rules: The Basic Syntax](https://www.modsecurity.org/CRS/Documentation/making.html).

For more information about ModSecurity's open source WAF rules, see [Mod Security's OWASP Core Rule Set documentation](https://www.modsecurity.org/CRS/Documentation/index.html).

Parameters:

template - the value to set

Returns:

this builder

freeformTags

public CreateCustomProtectionRuleDetails.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public CreateCustomProtectionRuleDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

build

public CreateCustomProtectionRuleDetails build()

copy

public CreateCustomProtectionRuleDetails.Builder copy(CreateCustomProtectionRuleDetails model)