"create"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


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

Creates a new Protection Policy.


Usage
=====

   oci recovery protection-policy create [OPTIONS]


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

--backup-retention-period-in-days [integer]

The maximum number of days to retain backups for a protected database.

--compartment-id, -c [text]

Compartment Identifier

--display-name [text]

A user provided name for the protection policy. The ‘displayName’ does
not have to be unique, and it can be modified. Avoid entering
confidential information.


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

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}*. For
more information, see Resource Tags 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.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name,
type or scope. Exists for cross-compatibility only. Example: *{“bar-
key”: “value”}* 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 work request to reach the state
defined by "--wait-for-state". Defaults to 1200 seconds.

--must-enforce-cloud-locality [boolean]

Indicates whether the protection policy enforces Recovery Service to
retain backups in the same cloud service environment where your Oracle
Database is provisioned. This parameter is applicable if your Oracle
Database runs in a different cloud service environment, such as
Microsoft Azure. If you set the mustEnforceCloudLocality parameter to
TRUE, then Recovery Service stores the database backups locally in the
same cloud service environment where the database resides. For
example, if your Oracle Database is provisioned on Microsoft Azure,
then Recovery Service stores the database backups in Azure. Note: You
cannot change the mustEnforceCloudLocality setting for a protection
policy after you create it.

--policy-locked-date-time [text]

An RFC3339 formatted datetime string that specifies the exact date and
time for the retention lock to take effect and permanently lock the
retention period defined in the policy.

* The retention lock feature controls whether Recovery Service
  strictly preserves backups for the duration defined in a policy.
  Retention lock is useful to enforce recovery window compliance and
  to prevent unintentional modifications to protected database
  backups. * Recovery Service enforces a 14-day delay before the
  retention lock set for a policy can take effect. Therefore, you must
  set policyLockedDateTime  to a date that occurs 14 days after the
  current date. * For example, assuming that the current date is Aug
  1, 2023 9 pm, you can set policyLockedDateTime  to
  ‘2023-08-15T21:00:00.600Z’ (Aug 15, 2023, 9:00 pm), or greater. *
  During the 14-day delay period, you can either increase or decrease
  the retention period in the policy. * However, you are only allowed
  to increase the retention period on or after the retention lock
  date. * You cannot change the value of policyLockedDateTime if the
  retention lock is already in effect.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource
and uses a work request to track the progress of the operation.
Specify this option to perform the action and then wait until the work
request reaches a certain 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:

   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the work request
has reached the state defined by "--wait-for-state". Defaults to 30
seconds.


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

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

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export backup_retention_period_in_days=<substitute-value-of-backup_retention_period_in_days> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/recovery/protection-policy/create.html#cmdoption-backup-retention-period-in-days
       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/recovery/protection-policy/create.html#cmdoption-compartment-id
       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/recovery/protection-policy/create.html#cmdoption-display-name

       oci recovery protection-policy create --backup-retention-period-in-days $backup_retention_period_in_days --compartment-id $compartment_id --display-name $display_name
