PutBucketEncryption
This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket. You can alsoblock encryption types using this operation.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the formathttps://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, seeRegional and Zonal endpoints for directory buckets in Availability Zones in theAmazon S3 User Guide. For more information about endpoints in Local Zones, seeConcepts for directory buckets in Local Zones in theAmazon S3 User Guide.
By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).
General purpose buckets
You can optionally configure default encryption for a bucket by using server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS) or dual-layer server-side encryption with AWS KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configureAmazon S3 Bucket Keys. For information about the bucket default encryption feature, seeAmazon S3 Bucket Default Encryption in theAmazon S3 User Guide.
If you use PutBucketEncryption to set yourdefault bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 doesn't validate the KMS key ID provided in PutBucketEncryption requests.
Directory buckets - You can optionally configure default encryption for a bucket by using server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
CreateSessionrequests orPUTobject requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, seeSpecifying server-side encryption with AWS KMS for new object uploads.Your SSE-KMS configuration can only support 1customer managed key per directory bucket's lifetime. TheAWS managed key (
aws/s3) isn't supported.S3 Bucket Keys are always enabled for
GETandPUToperations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, throughCopyObject,UploadPartCopy,the Copy operation in Batch Operations, orthe import jobs. In this case, Amazon S3 makes a call to AWS KMS every time a copy request is made for a KMS-encrypted object.When you specify anAWS KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
For directory buckets, if you use PutBucketEncryption to set yourdefault bucket encryption to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.
If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
Also, this action requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
- Permissions
General purpose bucket permissions - The
s3:PutEncryptionConfigurationpermission is required in a policy. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, seePermissions Related to Bucket Operations andManaging Access Permissions to Your Amazon S3 Resources in theAmazon S3 User Guide.Directory bucket permissions - To grant access to this API operation, you must have the
s3express:PutEncryptionConfigurationpermission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the AWS account that owns the resource. For more information about directory bucket policies and permissions, seeAWS Identity and Access Management (IAM) for S3 Express One Zone in theAmazon S3 User Guide.To set a directory bucket default encryption with SSE-KMS, you must also have the
kms:GenerateDataKeyand thekms:Decryptpermissions in IAM identity-based policies and AWS KMS key policies for the target AWS KMS key.
- HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com.
The following operations are related toPutBucketEncryption:
You must URL encode any signed header values that contain spaces. For example, if your header value ismy file.txt, containing two spaces aftermy, you must URL encode this value tomy%20%20file.txt.
Request Syntax
PUT /?encryption HTTP/1.1Host:Bucket.s3.amazonaws.comContent-MD5:ContentMD5x-amz-sdk-checksum-algorithm:ChecksumAlgorithmx-amz-expected-bucket-owner:ExpectedBucketOwner<?xml version="1.0" encoding="UTF-8"?><ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ApplyServerSideEncryptionByDefault> <KMSMasterKeyID>string</KMSMasterKeyID> <SSEAlgorithm>string</SSEAlgorithm> </ApplyServerSideEncryptionByDefault> <BlockedEncryptionTypes> <EncryptionType>string</EncryptionType> ... </BlockedEncryptionTypes> <BucketKeyEnabled>boolean</BucketKeyEnabled> </Rule> ...</ServerSideEncryptionConfiguration>URI Request Parameters
The request uses the following URI parameters.
- Bucket
Specifies default encryption for a bucket using server-side encryption with different key options.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the formatbucket-base-name--zone-id--x-s3(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, seeDirectory bucket naming rules in theAmazon S3 User GuideRequired: Yes
- Content-MD5
The Base64 encoded 128-bit
MD5digest of the server-side encryption configuration.For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.
This functionality is not supported for directory buckets.
- x-amz-expected-bucket-owner
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden(access denied).For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code
501 Not Implemented.- x-amz-sdk-checksum-algorithm
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request. For more information, seeChecking object integrity in theAmazon S3 User Guide.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithmparameter.For directory buckets, when you use AWS SDKs,
CRC32is the default checksum algorithm that's used for performance.Valid Values:
CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME
Request Body
The request accepts the following data in XML format.
- ServerSideEncryptionConfiguration
Root level tag for the ServerSideEncryptionConfiguration parameters.
Required: Yes
- Rule
Container for information about a particular server-side encryption configuration rule.
Type: Array ofServerSideEncryptionRule data types
Required: Yes
Response Syntax
HTTP/1.1 200Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Examples
In the request, you specify the encryption configuration in the request body. The encryption configuration is specified as XML, as shown in the following examples that show setting encryption using SSE-S3, SSE-KMS, or DSSE-KMS.
Request Body for Setting SSE-S3 for general purpose buckets
This example illustrates one usage of PutBucketEncryption.
<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ApplyServerSideEncryptionByDefault> <SSEAlgorithm>AES256</SSEAlgorithm> </ApplyServerSideEncryptionByDefault> </Rule> </ServerSideEncryptionConfiguration>Request Body for Setting SSE-KMS for general purpose buckets
This example illustrates one usage of PutBucketEncryption.
<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ApplyServerSideEncryptionByDefault> <SSEAlgorithm>aws:kms:dsse</SSEAlgorithm> <KMSKeyID>arn:aws:kms:us-east-1:1234/5678example</KMSKeyID> </ApplyServerSideEncryptionByDefault> </Rule> </ServerSideEncryptionConfiguration>Set the Default Encryption Configuration for an S3 general purpose bucket
The following is an example of a PUT /? encryption request that specifies to use SSE-KMS encryption.
PUT /?encryption HTTP/1.1Host: examplebucket.<Region>s3.amazonaws.comDate: Wed, 06 Sep 2017 12:00:00 GMTAuthorization: authorization Content-Length: length<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <ApplyServerSideEncryptionByDefault> <SSEAlgorithm>aws:kms</SSEAlgorithm> <KMSKeyID>arn:aws:kms:us-east-1:1234/5678example</KMSKeyID> </ApplyServerSideEncryptionByDefault></Rule></ServerSideEncryptionConfiguration>Block SSE-C encryption for a bucket
The following is an example of a request to prevent writing new objects to the bucket that uses server-side encryption with customer-provided keys (SSE-C). For more information, seeBlocking or unblocking SSE-C for a general purpose bucket.
To allow the use of SSE-C encryption in your write requests to a bucket, pass the valueNONE instead ofSSE-C.
<ServerSideEncryptionConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Rule> <BlockedEncryptionTypes> <EncryptionType>SSE-C</EncryptionType> </BlockedEncryptionTypes> </Rule> </ServerSideEncryptionConfiguration>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
