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

    Interface PutBucketAclCommandInput

    The input for PutBucketAclCommand.

    interface PutBucketAclCommandInput {
        ACL?: BucketCannedACL;
        AccessControlPolicy?: AccessControlPolicy;
        Bucket: string | undefined;
        ContentMD5?: string;
        ChecksumAlgorithm?: ChecksumAlgorithm;
        GrantFullControl?: string;
        GrantRead?: string;
        GrantReadACP?: string;
        GrantWrite?: string;
        GrantWriteACP?: string;
        ExpectedBucketOwner?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    The canned ACL to apply to the bucket.

    AccessControlPolicy?: AccessControlPolicy

    Contains the elements that set the ACL permissions for an object per grantee.

    Bucket: string | undefined

    The bucket to which to apply the ACL.

    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 data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

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

    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.

    GrantFullControl?: string

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    GrantRead?: string

    Allows grantee to list the objects in the bucket.

    GrantReadACP?: string

    Allows grantee to read the bucket ACL.

    GrantWrite?: string

    Allows grantee to create new objects in the bucket.

    For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    GrantWriteACP?: string

    Allows grantee to write the ACL for the applicable bucket.

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