@backblaze-labs/b2-sdk - v0.1.0
    Preparing search index...

    Interface CreateBucketRequest

    Request parameters for the b2_create_bucket API call.

    interface CreateBucketRequest {
        accountId: AccountId;
        bucketInfo?: Record<string, string>;
        bucketName: string;
        bucketType: BucketType;
        corsRules?: readonly CorsRule[];
        defaultRetention?: BucketRetentionPolicy;
        defaultServerSideEncryption?: EncryptionSetting;
        fileLockEnabled?: boolean;
        lifecycleRules?: readonly LifecycleRule[];
        replicationConfiguration?: ReplicationConfiguration;
    }
    Index

    Properties

    accountId bucketInfo? bucketName bucketType corsRules? defaultRetention? defaultServerSideEncryption? fileLockEnabled? lifecycleRules? replicationConfiguration?

    Properties

    accountId: AccountId

    Account that will own the new bucket.

    bucketInfo?: Record<string, string>

    Optional user-defined key-value metadata.

    bucketName: string

    Globally unique name for the bucket.

    bucketType: BucketType

    Access level for the bucket.

    corsRules?: readonly CorsRule[]

    Optional CORS rules.

    defaultRetention?: BucketRetentionPolicy

    Optional default Object Lock retention policy.

    defaultServerSideEncryption?: EncryptionSetting

    Optional default server-side encryption setting.

    fileLockEnabled?: boolean

    Whether to enable Object Lock on the bucket. Cannot be changed after creation.

    lifecycleRules?: readonly LifecycleRule[]

    Optional lifecycle rules.

    replicationConfiguration?: ReplicationConfiguration

    Optional replication configuration.

    Settings

    Member Visibility

    On This Page

    Properties