IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface PutBucketEncryptionCommandInput

    interface PutBucketEncryptionCommandInput {
        Bucket: string | undefined;
        ContentMD5?: string;
        ChecksumAlgorithm?: ChecksumAlgorithm;
        ServerSideEncryptionConfiguration:
            | ServerSideEncryptionConfiguration
            | undefined;
        ExpectedBucketOwner?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Bucket: string | undefined

    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 format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

    Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@ibm-cos/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

    ContentMD5?: string

    The Base64 encoded 128-bit MD5 digest of the server-side encryption configuration.

    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

    This functionality is not supported for directory buckets.

    ChecksumAlgorithm?: ChecksumAlgorithm

    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-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

    If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

    For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

    ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined

    Specifies the default server-side-encryption configuration.

    ExpectedBucketOwner?: string

    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.