Object Storage CLI Command Reference

Every dcloud s3 command. The shape is dcloud <service> <resource> <verb>; every command also takes the global flags (--json, --profile, --dry-run, …).

dcloud s3 buckets

S3-compatible buckets; objects are reached over the S3 protocol

  • listList buckets, with the S3 endpoint to point clients at
  • createCreate a bucket
  • getOne bucket with its path-style and virtual-hosted URLs
  • deleteDelete an empty bucket

dcloud s3 bucket-objects

The console's object browser: list by folder, presigned download/upload, delete — as the caller, through the S3 gateway

  • listOne page (200) of objects and folders under a prefix
  • download-urlA presigned GET for one object, valid 15 minutes, saved as a download
  • upload-urlA presigned PUT for one key, valid 15 minutes
  • multipart-createStart a multipart upload (files over 5 GiB must use one)
  • multipart-part-urlsPresigned PUT URLs for up to 100 parts, valid 15 minutes
  • multipart-partsThe parts of an unfinished upload stored so far, to resume it
  • multipart-completeAssemble the stored parts into the object
  • multipart-abortAbort an unfinished upload; its stored parts are deleted
  • list-versionsOne page (200) of object versions and delete markers under a prefix
  • restore-versionMake an older version the current one (copied over its key)
  • delete-versionsDelete up to 1000 versions for good; deleting a delete marker undeletes
  • deleteDelete up to 1000 objects
  • countHow many objects, older versions and delete markers a folder or the bucket holds
  • emptyEmpty the bucket in the background: every object, version and delete marker, for good
  • empty-statusThe bucket’s latest empty job and how far it got
  • empty-cancelStop emptying the bucket; what was deleted stays deleted
  • delete-prefixDelete everything under a folder; with prefix "" and allVersions, empty the bucket

dcloud s3 bucket-access

Who may reach a bucket without a key: Block Public Access, the bucket policy, and the static website

  • getBlock Public Access flags, the policy, whether the bucket is public, the website
  • get-blockThe four Block Public Access flags, and whether the bucket is public
  • get-policyThe bucket policy (null when there is none)
  • get-websiteThe website configuration (null when off), its host and custom domains
  • set-blockSet the four Block Public Access flags (all true on a new bucket)
  • set-policySet the bucket policy (AWS grammar: the public, organizations, IAM users)
  • delete-policyRemove the bucket policy
  • set-websiteServe the bucket as a static website on https://<bucket>.s3-website.<root>
  • delete-websiteStop serving the bucket as a website
  • add-domainAnswer the website on a domain of your own
  • remove-domainRemove a custom domain from the website

dcloud s3 bucket-encryption

Default encryption: every object is encrypted at rest under the bucket’s key, wrapped by the platform key or a KMS key of yours

  • getWhich key encrypts the bucket’s objects, and whether it is usable now
  • setMove the bucket to a KMS key, or back to the platform key
  • deleteReturn the bucket to the platform key (encryption itself stays on)

dcloud s3 bucket-remote-copy

A copy of every object of a bucket on a storage cluster in another location, read while the cluster is unavailable

  • getWhether the bucket keeps a remote copy, where, and how many keys still wait
  • setTurn the remote copy on (every existing object is copied too) or off

dcloud s3 bucket-replication

Cross-zone replication (S3 CRR): copy a bucket’s objects to another bucket of the organization, in either zone

  • getThe replication rules, and how many keys are pending or failed
  • setReplace the replication rules
  • deleteStop replicating (replicas already made are kept)
  • retryGive keys whose copy failed new attempts

dcloud s3 bucket-versioning

Keep every version of every object

  • getVersioning status: Enabled, Suspended or Off
  • setEnable or suspend versioning (it can never be removed)

dcloud s3 bucket-cors

Which web pages may call the bucket from a browser (CORS)

  • getThe bucket’s CORS rules; null when it has none
  • setReplace the bucket’s CORS rules
  • deleteRemove every CORS rule: browsers on other sites can no longer call the bucket

dcloud s3 bucket-lifecycle

Expire objects, old versions and unfinished uploads by age

  • getThe lifecycle rules
  • setReplace the lifecycle rules
  • deleteRemove every lifecycle rule

dcloud s3 access-keys

S3 access keys; each acts with the permissions of the IAM user who created it

  • listList S3 access keys (ids and status, never secrets)
  • createCreate an S3 access key
  • deleteDelete an S3 access key

dcloud s3 temporary-credentials

Short-lived S3 credentials with a session token; they act with the caller’s permissions and expire on their own

  • createCreate temporary S3 credentials (15 minutes to 12 hours, default 1 hour)

Generated from the API description, the same one the API checks requests against and the CLI is built from.