``create``
==========
.. contents:: :local:
:depth: 1
Description
------------
Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds. Note that a maximum of 100 rules are supported on a bucket.
Usage
-----
.. code-block:: none
oci os retention-rule create [OPTIONS]
Required Parameters
--------------------
.. option:: --bucket-name, --bucket, -bn [text]
The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
Optional Parameters
--------------------
.. option:: --display-name [text]
A user-specified name for the retention rule. Names can be helpful in identifying retention rules. Avoid entering confidential information.
.. option:: --from-json [text]
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The :option:`--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/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
.. option:: --namespace-name, --namespace, -ns [text]
The Object Storage namespace used for the request. If not provided, this parameter will be obtained internally using a call to 'oci os ns get'
.. option:: --time-amount [integer]
The amount of time that objects in the bucket should be preserved for and which is calculated in relation to each object's Last-Modified timestamp. If time-amount is not specified, then there is no time limit and the objects in the bucket will be preserved indefinitely.
.. option:: --time-rule-locked [datetime]
The date and time as per `RFC 3339 <https://tools.ietf.org/html/rfc3339>`__ after which this rule is locked and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are allowed and no other properties can be changed. This property cannot be updated for rules that are in a locked state. Specifying it when a duration is not specified is considered an error.
The following datetime formats are supported:
UTC with microseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
Example: 2017-09-15T20:30:00.123456Z
UTC with milliseconds
***********************
.. code::
Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
UTC without milliseconds
**************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
UTC with minute precision
**************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Timezone with microseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
Timezone with milliseconds
***************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Timezone without milliseconds
*******************************
.. code::
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Timezone with minute precision
*******************************
.. code::
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
Short date and time
********************
The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
.. code::
Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'
Date Only
**********
This date will be taken as midnight UTC of that day
.. code::
Format: YYYY-MM-DD
Example: 2017-09-15
Epoch seconds
**************
.. code::
Example: 1412195400
.. option:: --time-unit [text]
The unit that should be used to interpret time-amount
Accepted values are:
.. code-block:: py
DAYS, YEARS
Global Parameters
------------------
Use ``oci --help`` for help on global parameters.
:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-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 <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.
.. code-block:: none
:class: copy-code-block
export bucket_name=<substitute-value-of-bucket_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os/retention-rule/create.html#cmdoption-bucket-name
oci os retention-rule create --bucket-name $bucket_name
Other Examples
------------------
Description
~~~~~~~~~~~~
Creates a new retention rule in the specified bucket.
Command
~~~~~~~~~~~~
.. code-block:: none
:class: copy-code-block
oci os retention-rule create -bn bucket-client
Output
~~~~~~~~~~~~
.. code-block:: json
{
"data": {
"display-name": "RetentionRule20221123105442",
"duration": null,
"etag": "b94d6d11-e531-4820-903b-dea10bdeb84a",
"id": "5e27a096-71ec-4a51-9d1d-5b23a13f8297",
"time-created": "2022-11-23T10:54:42.601000+00:00",
"time-modified": "2022-11-23T10:54:42.601000+00:00",
"time-rule-locked": null
},
"etag": "b94d6d11-e531-4820-903b-dea10bdeb84a"
}
Description
~~~~~~~~~~~~
Creates a new retention rule with specified name.
Command
~~~~~~~~~~~~
.. code-block:: none
:class: copy-code-block
oci os retention-rule create -bn bucket-client --display-name new-retention-rule
Output
~~~~~~~~~~~~
.. code-block:: json
{
"data": {
"display-name": "new-retention-rule",
"duration": null,
"etag": "2a367917-53fd-4e75-8642-3168c2116e92",
"id": "67d32cea-3327-48c8-8ece-19b938da5a50",
"time-created": "2022-11-23T10:56:40.796000+00:00",
"time-modified": "2022-11-23T10:56:40.796000+00:00",
"time-rule-locked": null
},
"etag": "2a367917-53fd-4e75-8642-3168c2116e92"
}
Description
~~~~~~~~~~~~
Creates a new retention rule in the specified namespace.
Command
~~~~~~~~~~~~
.. code-block:: none
:class: copy-code-block
oci os retention-rule create -bn bucket-client -ns bmcostests
Output
~~~~~~~~~~~~
.. code-block:: json
{
"data": {
"display-name": "RetentionRule20221123105712",
"duration": null,
"etag": "07a6de08-9628-43d6-91ce-1023017fbd98",
"id": "0195c351-65a8-43a4-9868-be90acea8ef3",
"time-created": "2022-11-23T10:57:12.863000+00:00",
"time-modified": "2022-11-23T10:57:12.863000+00:00",
"time-rule-locked": null
},
"etag": "07a6de08-9628-43d6-91ce-1023017fbd98"
}
Description
~~~~~~~~~~~~
Creates a new retention rule with specified amount of time for which objects in bucket should be preserved.
Command
~~~~~~~~~~~~
.. code-block:: none
:class: copy-code-block
oci os retention-rule create -bn bucket-client --time-amount 5 --time-unit DAYS
Output
~~~~~~~~~~~~
.. code-block:: json
{
"data": {
"display-name": "RetentionRule20221123105907",
"duration": {
"time-amount": 5,
"time-unit": "DAYS"
},
"etag": "c95aac9b-c87f-446d-a369-50eb870baef8",
"id": "98dbc93d-100e-4f4c-8e2b-0860ea38d958",
"time-created": "2022-11-23T10:59:07.380000+00:00",
"time-modified": "2022-11-23T10:59:07.380000+00:00",
"time-rule-locked": null
},
"etag": "c95aac9b-c87f-446d-a369-50eb870baef8"
}
Description
~~~~~~~~~~~~
Creates a new retention rule with rule locked on the specified time-rule-locked value
Command
~~~~~~~~~~~~
.. code-block:: none
:class: copy-code-block
oci os retention-rule create -bn bucket-client --time-rule-locked 2022-11-30T20:30:00.123456Z --time-amount 1 --time-unit DAYS
Output
~~~~~~~~~~~~
.. code-block:: json
{
"data": {
"display-name": "RetentionRule20221123110837",
"duration": {
"time-amount": 1,
"time-unit": "DAYS"
},
"etag": "8a6ebc3f-7f79-46f3-a961-e5951a091dd8",
"id": "7539d528-f7ee-4cb0-845e-e70e10207a6a",
"time-created": "2022-11-23T11:08:37.777000+00:00",
"time-modified": "2022-11-23T11:08:37.777000+00:00",
"time-rule-locked": "2022-11-30T20:30:00.123456+00:00"
},
"etag": "8a6ebc3f-7f79-46f3-a961-e5951a091dd8"
}