UNPKG

@aws-sdk/client-s3

Version:

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native

52 lines (51 loc) 3.59 kB
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { PutBucketEncryptionRequest } from "../models/models_0"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@aws-sdk/types"; export declare type PutBucketEncryptionCommandInput = PutBucketEncryptionRequest; export declare type PutBucketEncryptionCommandOutput = __MetadataBearer; /** * <p>This operation uses the <code>encryption</code> subresource to configure default * encryption and Amazon S3 Bucket Key for an existing bucket.</p> * <p>Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys * (SSE-S3) or AWS KMS customer master keys (SSE-KMS). If you specify default encryption * using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default * encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 default bucket encryption</a> * in the <i>Amazon Simple Storage Service Developer Guide</i>. For more information about S3 Bucket Keys, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> * <important> * <p>This operation requires AWS Signature Version 4. For more information, see <a href="sig-v4-authenticating-requests.html"> Authenticating Requests (AWS Signature * Version 4)</a>. </p> * </important> * <p>To use this operation, you must have permissions to perform the * <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission * by default. The bucket owner can grant this permission to others. For more information * about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Managing Access Permissions to Your Amazon S3 * Resources</a> in the Amazon Simple Storage Service Developer Guide. </p> * * <p class="title"> * <b>Related Resources</b> * </p> * <ul> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html">GetBucketEncryption</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html">DeleteBucketEncryption</a> * </p> * </li> * </ul> */ export declare class PutBucketEncryptionCommand extends $Command<PutBucketEncryptionCommandInput, PutBucketEncryptionCommandOutput, S3ClientResolvedConfig> { readonly input: PutBucketEncryptionCommandInput; constructor(input: PutBucketEncryptionCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketEncryptionCommandInput, PutBucketEncryptionCommandOutput>; private serialize; private deserialize; }