import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutBucketEncryptionRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutBucketEncryptionCommand}. */ export interface PutBucketEncryptionCommandInput extends PutBucketEncryptionRequest { } /** * @public * * The output of {@link PutBucketEncryptionCommand}. */ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer { } declare const PutBucketEncryptionCommand_base: { new (input: PutBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: PutBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.

* *

* 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 format https://s3express-control.region-code.amazonaws.com/bucket-name *. Virtual-hosted-style requests aren't supported. * For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the * Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the * Amazon 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 Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with * Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also * configure Amazon S3 Bucket * Keys. For information about the bucket default encryption feature, see Amazon S3 Bucket Default * Encryption in the Amazon S3 User Guide.
  *
- *
  If you use PutBucketEncryption to set your default 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 Key Management Service (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 * CreateSession requests or PUT object requests. Then, new objects * are automatically encrypted with the desired encryption settings. * For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
  *
- *
  Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. * The Amazon Web Services managed key (aws/s3) isn't supported. *
  *
- *
  S3 Bucket Keys are always enabled for GET and PUT operations 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, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or * the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
  *
- *
  When you specify an 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 your default 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 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 Amazon Web Services Signature Version 4. For more information, see Authenticating * Requests (Amazon Web Services Signature Version 4).

* *

Permissions

*
* General purpose bucket permissions - The * s3:PutEncryptionConfiguration permission 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, see Permissions Related to Bucket Operations and Managing Access Permissions to Your * Amazon S3 Resources in the Amazon S3 User Guide.
*
*
* Directory bucket permissions - To grant access to * this API operation, you must have the s3express:PutEncryptionConfiguration * permission 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 Amazon Web Services account that owns the resource. * For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
*
To set a directory bucket default encryption with SSE-KMS, you must also have the * kms:GenerateDataKey and the kms:Decrypt permissions in IAM * identity-based policies and KMS key policies for the target 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 to PutBucketEncryption:

*
* GetBucketEncryption *
*
*
* DeleteBucketEncryption *
*

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import * // import type { S3ClientConfig } from "@aws-sdk/client-s3"; * const config = {}; // type is S3ClientConfig * const client = new S3Client(config); * const input = { // PutBucketEncryptionRequest * Bucket: "STRING_VALUE", // required * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME", * ServerSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration * Rules: [ // ServerSideEncryptionRules // required * { // ServerSideEncryptionRule * ApplyServerSideEncryptionByDefault: { // ServerSideEncryptionByDefault * SSEAlgorithm: "AES256" || "aws:fsx" || "aws:kms" || "aws:kms:dsse", // required * KMSMasterKeyID: "STRING_VALUE", * }, * BucketKeyEnabled: true || false, * }, * ], * }, * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutBucketEncryptionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param PutBucketEncryptionCommandInput - {@link PutBucketEncryptionCommandInput} * @returns {@link PutBucketEncryptionCommandOutput} * @see {@link PutBucketEncryptionCommandInput} for command's `input` shape. * @see {@link PutBucketEncryptionCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * * @public */ export declare class PutBucketEncryptionCommand extends PutBucketEncryptionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutBucketEncryptionRequest; output: {}; }; sdk: { input: PutBucketEncryptionCommandInput; output: PutBucketEncryptionCommandOutput; }; }; }