put-bucket-overwrite-config

Updated at:

Sets the overwrite configuration for a bucket, preventing specified objects from being overwritten.

Notes

Requires the oss:PutBucketOverwriteConfig permission.

Command format

ossutil api put-bucket-overwrite-config --bucket value --overwrite-configuration value [flags]

Parameter

Type

Description

--bucket

string

Bucket name.

--overwrite-configuration

string

Overwrite rules for the bucket.

Note

--overwrite-configuration

Supports XML and JSON syntax:

  • XML syntax:

    <OverwriteConfiguration>
      <Rule>
        <Prefix>string</Prefix>
        <Suffix>string</Suffix>
        <Principals>
          <Principal>string</Principal>
          ...
        </Principals>
        <ID>string</ID>
        <Action>string</Action>
      </Rule>
      ...
    </OverwriteConfiguration>
  • JSON syntax:

    {
      "Rule": [
        {
          "Prefix": "string",
          "Suffix": "string",
          "Principals": {
            "Principal": ["string", ...]
          },
          "ID": "string",
          "Action": "string"
        },
        ...
      ]
    }

Examples

Set overwrite rules for the examplebucket bucket.

  • Use an XML configuration file (overwrite-configuration.xml):

    <?xml version="1.0" encoding="UTF-8"?>
    <OverwriteConfiguration>
       <Rule>
          <ID>rule-001</ID>
          <Action>forbid</Action>
          <Suffix>.txt</Suffix>
          <Principals>
              <Principal>277379621561571234</Principal>
          </Principals>
       </Rule>
    </OverwriteConfiguration>
    ossutil api put-bucket-overwrite-config --bucket examplebucket --overwrite-configuration file://overwrite-configuration.xml
  • Use a JSON configuration file (overwrite-configuration.json):

    {
        "Rule": {
          "ID": "rule-001",
          "Action": "forbid",
          "Suffix": ".txt",
          "Principals": {
            "Principal": "277379621561571234"
          }
        }
    }
    ossutil api put-bucket-overwrite-config --bucket examplebucket --overwrite-configuration file://overwrite-configuration.json
  • Pass the configuration as inline JSON.

    ossutil api put-bucket-overwrite-config --bucket examplebucket --overwrite-configuration "{\"Rule\":{\"ID\":\"rule-001\",\"Action\":\"forbid\",\"Suffix\":\".txt\",\"Principals\":{\"Principal\":\"277379621561571234\"}}}"