s3.bucket-encryption.set

Move the bucket to a KMS key, or back to the platform key

PUT /s3/api/buckets/{name}/encryptionIAM s3:PutEncryptionConfigurationChanges state

Re-wraps the bucket’s one data key: every object, old and new, follows the new key at once. Disabling or deleting that KMS key makes the objects unreadable until it is enabled again (deleted: for good). Needs kms:Encrypt on the key. Also over S3: PutBucketEncryption.

Request syntax

PUT /s3/api/buckets/{name}/encryption
{
  "kmsKeyId": "string"
}

Path parameters

  • nameRequired

    string

    Constraints: 3-63 chars, /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Request body

  • kmsKeyIdRequired

    string

    A KMS key of the organization (SSE-KMS), or null for the platform key (SSE-S3)

    May be null.

Response

200; data is { algorithm, kmsKeyId, active }: the encryption now in force.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow s3:PutEncryptionConfiguration on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud s3 bucket-encryption set name --kms-key-id example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_bucket-encryption_set.