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

    Interface PutBucketOwnershipControlsRequest

    interface PutBucketOwnershipControlsRequest {
        Bucket: string | undefined;
        ContentMD5?: string;
        ExpectedBucketOwner?: string;
        OwnershipControls: OwnershipControls | undefined;
        ChecksumAlgorithm?: ChecksumAlgorithm;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Bucket: string | undefined

    The name of the Amazon S3 bucket whose OwnershipControls you want to set.

    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 MD5 hash of the OwnershipControls request body.

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

    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).

    OwnershipControls: OwnershipControls | undefined

    The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

    ChecksumAlgorithm?: ChecksumAlgorithm

    Indicates the algorithm used to create the checksum for the object 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-algorithm 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.