"create"
********


Description
===========

Creates a new Custom Protection rule in the specified compartment.


Usage
=====

   oci waas custom-protection-rule create [OPTIONS]


Required Parameters
===================

--compartment-id, -c [text]

The OCID of the compartment in which to create the Custom Protection
rule.

--display-name [text]

A user-friendly name for the Custom Protection rule.

--template [text]

The template text of the Custom Protection rule. The syntax is based
on ModSecurity Rule Language. Additionaly it needs to include two
variables / placeholders which will be replaced during publishing.

* **{{mode}}** - rule action, defined by user in UI, like *OFF*,
  *DETECT* or *BLOCK*.

* **{{id_1}}** - unique rule ID which identifies a *SecRule*,
  generated by the system. Multiple IDs can be used by increasing the
  number of the variable for every *SecRule* defined in the template.

*Example usage:*   "`   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   *Cookie* header value
during second input analysis phase.   The disruptive *deny* action
takes effect only when *{{mode}}* is set to *BLOCK*.   The message is
logged either when *{{mode}}* is set to *DETECT* or *BLOCK*.

   For more information about ModSecurity's open source WAF rules, see
   Mod Security's documentation.


Optional Parameters
===================

--defined-tags [complex type]

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

Example:

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

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--description [text]

A description for the Custom Protection rule.

--freeform-tags [complex type]

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"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id -->
compartmentId), while the values of the keys need to be populated by
the user before using the sample file as an input to this command. For
any command option that accepts multiple values, the value of the key
can be a JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our "using CLI with
advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. Multiple
states can be specified, returning on the first state. For example, "
--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
whichever lifecycle state is reached first. If timeout is reached, a
return code of 2 is returned. For any other error, a return code of 1
is returned.

Accepted values are:

   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource to
see if it has reached the lifecycle state defined by "--wait-for-
state". Defaults to 30 seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth", "--cert-bundle", "--cli-rc-file", "--config-file", "--
debug", "--defaults-file", "--endpoint", "--generate-full-command-
json-input", "--generate-param-json-input", "--help", "--no-retry", "
--opc-client-request-id", "--opc-request-id", "--output", "--profile",
"--query", "--raw-output", "--region", "--request-id", "--version",
"-?", "-d", "-h", "-v"
