Creating an Object Storage Retention Rule

• Console
• CLI
• API

• 1. Open the navigation menu and click Storage. Under Object Storage & Archive Storage, click Buckets.
  2. Select the compartment from the list under List Scope. All buckets in that compartment are listed in tabular form. This is the compartment where the bucket you create is located.
  3. Click the bucket for which you're creating a retention rule. The bucket's Details page appears.
  4. Click Retention Rules under Resources. The Retention Rules list appears. All retention rules are listed in tabular form.
  5. Click Create Rule. The Create Retention Rule dialog box appears.
  6. Complete the following:

     • Name: Enter a name for the rule. The system generates a rule name that reflects the current year, month, day, and time, for example, retention-rule-20200229-1002. If you change this name, use letters, numbers, dashes, underscores, and periods.

     • Retention Type: Choose the retention rule type that you want to create:

       • Time-Bound rules have a user-defined duration. Object modification is prevented for the duration specified. Duration is applied to each object individually, and is based on the object's Last Modified timestamp. Enter values for the Retention Duration settings that appear.

       • Indefinite rules have no duration or expiration. Object modification is prevented until an indefinite rule is deleted.

     • Retention Duration: (Time-Bound type rules only) Enter values for the Retention Time Amount time amount and Retention Time Unit time unit in Days or Years.

     • Enable Retention Rule Lock: (optional) Select the check box to lock the rule. When a rule is locked, only an increase in the retention duration is allowed and the rule can only be deleted by deleting the bucket. A bucket must be empty to be deleted.

  7. Click Create.

  The rule is displayed in the Retention Rules list.

• Use the oci os retention-rule create command and required parameters to create a retention rule for a bucket:

  oci os retention-rule create --bucket-name bucket_name [OPTIONS]

  For example:

  oci os retention-rule create --display-name LegalHold
  {
    "data": {
      "duration": null,
      "etag": "7f51ef6c-3fca-48f7-9060-c129911c1a50",
      "id": "5772c87f-6723-4ecc-b44c-bef86643be92",
      "time-created": "2020-03-25T14:53:20.792000+00:00",
      "time-modified": "2020-03-25T14:53:20.792000+00:00",
      "time-rule-locked": null
    },
    "etag": "7f51ef6c-3fca-48f7-9060-c129911c1a50"
  }

  Giving the Retention Rule a Display Name

  Include the display-name parameter to give a user-specified name for the retention rule. Names can be helpful in identifying retention rules. For example:

  oci os retention-rule create --bucket-name MyBucket --display-name LegalHold
  {
    "data": {
      "display-name": "LegalHold",
      "duration": null,
      "etag": "7f51ef6c-3fca-48f7-9060-c129911c1a50",
      "id": "5772c87f-6723-4ecc-b44c-bef86643be92",
      "time-created": "2020-03-25T14:53:20.792000+00:00",
      "time-modified": "2020-03-25T14:53:20.792000+00:00",
      "time-rule-locked": null
    },
    "etag": "7f51ef6c-3fca-48f7-9060-c129911c1a50"
  }

  Creating a Time-Bound Retention Rule

  Include the time-amount and time-unit parameters to set a time period in days or years for how long the retention rule applies. For example:

  oci os retention-rule create --bucket-name MyBucket --time-amount 5 --time-unit days
  {
    "data": {
      "duration": {
        "time-amount": 5,
        "time-unit": "DAYS"
      },
      "etag": "efb9178f-4213-49f7-878d-7bbe57decc0b",
      "id": "89f4ca0c-4ad9-4fa5-8005-95e7741c531c",
      "time-created": "2020-03-25T15:08:01.601000+00:00",
      "time-modified": "2020-03-25T15:08:01.601000+00:00",
      "time-rule-locked": null
    },
    "etag": "efb9178f-4213-49f7-878d-7bbe57decc0b"
  }

  If you don't specify a time amount and unit, there is no time limit and the objects in the bucket are preserved indefinitely.

  Locking the Retention Rule

  Include the time-rule-locked parameter and a date timestamp after which this rule is locked and can only be deleted by deleting the bucket. For example:

  oci os retention-rule create --bucket-name MyBucket --time-rule-locked 2017-09-15T20:30:00.123Z
  {
    "data": {
      "etag": "efb9178f-4213-49f7-878d-7bbe57decc0b",
      "id": "89f4ca0c-4ad9-4fa5-8005-95e7741c531c",
      "time-created": "2020-03-25T15:08:01.601000+00:00",
      "time-modified": "2020-03-25T15:08:01.601000+00:00",
      "time-rule-locked": 2017-09-15T20:30:00.123Z
    },
    "etag": "efb9178f-4213-49f7-878d-7bbe57decc0b"
  }

  See oci os retention-rule create for the supported date timestamp formats you can use with this parameter.

  After a rule is locked, only increases in the duration are allowed and no other properties can be changed. You can't update this property for rules that are in a locked state. Specifying it when a duration isn't specified is considered an error.

  For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

• Run the CreateRetentionRule operation to create a retention rule for a bucket.