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

    Interface CreateBucketCommandInput

    The input for CreateBucketCommand.

    interface CreateBucketCommandInput {
        IBMServiceInstanceId?: string;
        IBMSSEKPEncryptionAlgorithm?: string;
        IBMSSEKPCustomerRootKeyCrn?: string;
        ACL?: BucketCannedACL;
        Bucket: string | undefined;
        CreateBucketConfiguration?: CreateBucketConfiguration;
        GrantFullControl?: string;
        GrantRead?: string;
        GrantReadACP?: string;
        GrantWrite?: string;
        GrantWriteACP?: string;
        ObjectLockEnabledForBucket?: boolean;
        ObjectOwnership?: ObjectOwnership;
    }

    Hierarchy (View Summary)

    Index

    Properties

    IBMServiceInstanceId?: string

    IBM Cloud Service Instance ID associated with the request.

    IBMSSEKPEncryptionAlgorithm?: string

    SSE-KP encryption algorithm (e.g., AES256, AES-GCM variants if applicable).

    IBMSSEKPCustomerRootKeyCrn?: string

    The Cloud Resource Name (CRN) of the customer root key in IBM Key Protect used for SSE-KP.

    The canned ACL to apply to the bucket.

    This functionality is not supported for directory buckets.

    Bucket: string | undefined

    The name of the bucket to create.

    General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.

    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

    CreateBucketConfiguration?: CreateBucketConfiguration

    The configuration information for the bucket.

    GrantFullControl?: string

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

    This functionality is not supported for directory buckets.

    GrantRead?: string

    Allows grantee to list the objects in the bucket.

    This functionality is not supported for directory buckets.

    GrantReadACP?: string

    Allows grantee to read the bucket ACL.

    This functionality is not supported for directory buckets.

    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.

    This functionality is not supported for directory buckets.

    GrantWriteACP?: string

    Allows grantee to write the ACL for the applicable bucket.

    This functionality is not supported for directory buckets.

    ObjectLockEnabledForBucket?: boolean

    Specifies whether you want S3 Object Lock to be enabled for the new bucket.

    This functionality is not supported for directory buckets.

    ObjectOwnership?: ObjectOwnership

    The container element for object ownership for a bucket's ownership controls.

    BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

    ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

    BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

    By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

    This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.