Skip to content

Latest commit

 

History

History
97 lines (74 loc) · 3.18 KB

File metadata and controls

97 lines (74 loc) · 3.18 KB

rc bucket

Purpose

The rc bucket operation is the preferred noun-first entry point for bucket-oriented workflows. It groups bucket listing, creation, deletion, notification, CORS, versioning, quota, anonymous access, lifecycle, and replication operations under one command family.

Syntax

rc [GLOBAL OPTIONS] bucket <COMMAND>
rc bucket list [OPTIONS] <PATH>
rc bucket create [OPTIONS] <ALIAS/BUCKET>
rc bucket remove [OPTIONS] <ALIAS/BUCKET>
rc bucket event <add|list|remove> ...
rc bucket cors <list|set|remove> ...
rc bucket version <enable|suspend|info|list> ...
rc bucket quota <set|info|clear> ...
rc bucket anonymous <set|set-json|get|get-json|list|links> ...
rc bucket lifecycle <rule|tier|restore> ...
rc bucket replication <add|update|list|status|remove|export|import> ...

Commands

Command Description
list List buckets for an alias or list objects under a bucket path.
create Create a bucket.
remove Remove a bucket.
event Manage bucket notification rules.
cors Manage bucket CORS rules.
version Manage bucket versioning and object versions.
quota Manage bucket quota.
anonymous Manage anonymous bucket or prefix access.
lifecycle Manage lifecycle rules, remote tiers, and object restore requests.
replication Manage bucket replication rules and replication status.

Parameters

Parameter Description
PATH ALIAS/, ALIAS/BUCKET, or ALIAS/BUCKET/PREFIX.
--recursive Recursively list objects for bucket list.
--versions Include object versions when listing supported versioned buckets.
--summarize Show totals only for list output.
--ignore-existing Do not fail if the bucket already exists when creating it.
--with-versioning Enable versioning when creating the bucket.
--with-lock Enable object lock when creating the bucket.
--force Force destructive or capability-gated operations where supported.
--dangerous Remove a bucket even when incomplete multipart uploads exist.

Examples

List buckets for an alias:

rc bucket list local/

Create a versioned bucket with object lock:

rc bucket create local/archive --with-versioning --with-lock

List notification rules:

rc bucket event list local/archive

Set CORS from an XML or JSON file:

rc bucket cors set local/archive cors.xml

Check replication status:

rc bucket replication status local/archive

Behavior

Prefer rc bucket ... for new scripts. Legacy commands such as rc mb, rc rb, rc event, rc cors, rc version, rc anonymous, rc quota, rc ilm, and rc replicate remain available and delegate to the same implementations.

Global options shown in command syntax use the same meaning everywhere:

Option Description
--format auto|human|json Select automatic, human-readable, or JSON output.
--json Emit JSON output where the command supports structured output.
--no-color Disable terminal colors.
--no-progress Disable progress bars.
-q, --quiet Suppress non-error output.
--debug Enable debug logging.