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

    Interface UpdateBucketRequest

    Request parameters for the b2_update_bucket API call.

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

    Properties

    accountId bucketId bucketInfo? bucketType? corsRules? defaultRetention? defaultServerSideEncryption? fileLockEnabled? ifRevisionIs? lifecycleRules? replicationConfiguration?

    Properties

    accountId: AccountId

    Account that owns the bucket.

    bucketId: BucketId

    ID of the bucket to update.

    bucketInfo?: Record<string, string>

    Updated user-defined key-value metadata. Replaces all existing metadata.

    bucketType?: BucketType

    New access level for the bucket.

    corsRules?: readonly CorsRule[]

    Updated CORS rules. Replaces all existing rules.

    defaultRetention?: BucketRetentionPolicy

    Updated default Object Lock retention policy.

    defaultServerSideEncryption?: EncryptionSetting

    Updated default server-side encryption setting.

    fileLockEnabled?: boolean

    Whether to enable Object Lock. Can only transition from disabled to enabled.

    ifRevisionIs?: number

    Optimistic locking: only update if the bucket's current revision matches this value.

    lifecycleRules?: readonly LifecycleRule[]

    Updated lifecycle rules. Replaces all existing rules.

    replicationConfiguration?: ReplicationConfiguration

    Updated replication configuration.

    Settings

    Member Visibility

    On This Page

    Properties