Databricks SDK for JavaScript
    Preparing search index...

    Interface FailoverGroup

    A failover group manages disaster recovery across workspace sets, coordinating Unity Catalog and workspace assets replication.

    interface FailoverGroup {
        createTime?: Instant;
        effectivePrimaryRegion?: string;
        etag?: string;
        hasReplicationPointBlockingErrors?: boolean;
        initialPrimaryRegion?: string;
        initialReplicationProgress?: InitialReplicationProgress;
        name?: string;
        regions?: string[];
        replicationPoint?: Instant;
        state?: FailoverGroup_State;
        unityCatalogAssets?: UcReplicationConfig;
        updateTime?: Instant;
        workspaceSets?: WorkspaceSet[];
    }
    Index

    Properties

    createTime? effectivePrimaryRegion? etag? hasReplicationPointBlockingErrors? initialPrimaryRegion? initialReplicationProgress? name? regions? replicationPoint? state? unityCatalogAssets? updateTime? workspaceSets?

    Properties

    createTime?: Instant

    Time at which this failover group was created.

    effectivePrimaryRegion?: string

    Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover.

    etag?: string

    Opaque version string for optimistic locking. Server-generated and returned in responses.

    hasReplicationPointBlockingErrors?: boolean

    True if errors currently block the replication point.

    initialPrimaryRegion?: string

    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses.

    initialReplicationProgress?: InitialReplicationProgress

    Initial replication progress of all in-scope assets. Set only when the FailoverGroup is in INITIAL_REPLICATION state.

    name?: string

    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}.

    regions?: string[]

    List of all regions participating in this failover group.

    replicationPoint?: Instant

    The latest point in time to which data has been replicated.

    state?: FailoverGroup_State

    Aggregate state of the failover group.

    unityCatalogAssets?: UcReplicationConfig

    Unity Catalog replication configuration.

    updateTime?: Instant

    Time at which this failover group was last modified.

    workspaceSets?: WorkspaceSet[]

    Workspace sets, each containing workspaces that replicate to each other.

    Settings

    Member Visibility

    On This Page

    Properties