1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. DisasterRecoveryFailoverGroup
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi

    Private Preview

    Create DisasterRecoveryFailoverGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DisasterRecoveryFailoverGroup(name: string, args: DisasterRecoveryFailoverGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DisasterRecoveryFailoverGroup(resource_name: str,
                                      args: DisasterRecoveryFailoverGroupArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DisasterRecoveryFailoverGroup(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      failover_group_id: Optional[str] = None,
                                      initial_primary_region: Optional[str] = None,
                                      parent: Optional[str] = None,
                                      regions: Optional[Sequence[str]] = None,
                                      workspace_sets: Optional[Sequence[DisasterRecoveryFailoverGroupWorkspaceSetArgs]] = None,
                                      etag: Optional[str] = None,
                                      unity_catalog_assets: Optional[DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs] = None)
    func NewDisasterRecoveryFailoverGroup(ctx *Context, name string, args DisasterRecoveryFailoverGroupArgs, opts ...ResourceOption) (*DisasterRecoveryFailoverGroup, error)
    public DisasterRecoveryFailoverGroup(string name, DisasterRecoveryFailoverGroupArgs args, CustomResourceOptions? opts = null)
    public DisasterRecoveryFailoverGroup(String name, DisasterRecoveryFailoverGroupArgs args)
    public DisasterRecoveryFailoverGroup(String name, DisasterRecoveryFailoverGroupArgs args, CustomResourceOptions options)
    
    type: databricks:DisasterRecoveryFailoverGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "databricks_disasterrecoveryfailovergroup" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DisasterRecoveryFailoverGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DisasterRecoveryFailoverGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DisasterRecoveryFailoverGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DisasterRecoveryFailoverGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DisasterRecoveryFailoverGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var disasterRecoveryFailoverGroupResource = new Databricks.DisasterRecoveryFailoverGroup("disasterRecoveryFailoverGroupResource", new()
    {
        FailoverGroupId = "string",
        InitialPrimaryRegion = "string",
        Parent = "string",
        Regions = new[]
        {
            "string",
        },
        WorkspaceSets = new[]
        {
            new Databricks.Inputs.DisasterRecoveryFailoverGroupWorkspaceSetArgs
            {
                Name = "string",
                ReplicateWorkspaceAssets = false,
                WorkspaceIds = new[]
                {
                    "string",
                },
                StableUrlNames = new[]
                {
                    "string",
                },
            },
        },
        Etag = "string",
        UnityCatalogAssets = new Databricks.Inputs.DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs
        {
            Catalogs = new[]
            {
                new Databricks.Inputs.DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalogArgs
                {
                    Name = "string",
                },
            },
            DataReplicationWorkspaceSet = "string",
            LocationMappings = new[]
            {
                new Databricks.Inputs.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingArgs
                {
                    Name = "string",
                    UriByRegions = new[]
                    {
                        new Databricks.Inputs.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegionArgs
                        {
                            Region = "string",
                            Uri = "string",
                        },
                    },
                },
            },
        },
    });
    
    example, err := databricks.NewDisasterRecoveryFailoverGroup(ctx, "disasterRecoveryFailoverGroupResource", &databricks.DisasterRecoveryFailoverGroupArgs{
    	FailoverGroupId:      pulumi.String("string"),
    	InitialPrimaryRegion: pulumi.String("string"),
    	Parent:               pulumi.String("string"),
    	Regions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkspaceSets: databricks.DisasterRecoveryFailoverGroupWorkspaceSetArray{
    		&databricks.DisasterRecoveryFailoverGroupWorkspaceSetArgs{
    			Name:                     pulumi.String("string"),
    			ReplicateWorkspaceAssets: pulumi.Bool(false),
    			WorkspaceIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			StableUrlNames: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Etag: pulumi.String("string"),
    	UnityCatalogAssets: &databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs{
    		Catalogs: databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalogArray{
    			&databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalogArgs{
    				Name: pulumi.String("string"),
    			},
    		},
    		DataReplicationWorkspaceSet: pulumi.String("string"),
    		LocationMappings: databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingArray{
    			&databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingArgs{
    				Name: pulumi.String("string"),
    				UriByRegions: databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegionArray{
    					&databricks.DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegionArgs{
    						Region: pulumi.String("string"),
    						Uri:    pulumi.String("string"),
    					},
    				},
    			},
    		},
    	},
    })
    
    resource "databricks_disasterrecoveryfailovergroup" "disasterRecoveryFailoverGroupResource" {
      failover_group_id      = "string"
      initial_primary_region = "string"
      parent                 = "string"
      regions                = ["string"]
      workspace_sets {
        name                       = "string"
        replicate_workspace_assets = false
        workspace_ids              = ["string"]
        stable_url_names           = ["string"]
      }
      etag = "string"
      unity_catalog_assets = {
        catalogs = [{
          "name" = "string"
        }]
        data_replication_workspace_set = "string"
        location_mappings = [{
          "name" = "string"
          "uriByRegions" = [{
            "region" = "string"
            "uri"    = "string"
          }]
        }]
      }
    }
    
    var disasterRecoveryFailoverGroupResource = new DisasterRecoveryFailoverGroup("disasterRecoveryFailoverGroupResource", DisasterRecoveryFailoverGroupArgs.builder()
        .failoverGroupId("string")
        .initialPrimaryRegion("string")
        .parent("string")
        .regions("string")
        .workspaceSets(DisasterRecoveryFailoverGroupWorkspaceSetArgs.builder()
            .name("string")
            .replicateWorkspaceAssets(false)
            .workspaceIds("string")
            .stableUrlNames("string")
            .build())
        .etag("string")
        .unityCatalogAssets(DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs.builder()
            .catalogs(DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalogArgs.builder()
                .name("string")
                .build())
            .dataReplicationWorkspaceSet("string")
            .locationMappings(DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingArgs.builder()
                .name("string")
                .uriByRegions(DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegionArgs.builder()
                    .region("string")
                    .uri("string")
                    .build())
                .build())
            .build())
        .build());
    
    disaster_recovery_failover_group_resource = databricks.DisasterRecoveryFailoverGroup("disasterRecoveryFailoverGroupResource",
        failover_group_id="string",
        initial_primary_region="string",
        parent="string",
        regions=["string"],
        workspace_sets=[{
            "name": "string",
            "replicate_workspace_assets": False,
            "workspace_ids": ["string"],
            "stable_url_names": ["string"],
        }],
        etag="string",
        unity_catalog_assets={
            "catalogs": [{
                "name": "string",
            }],
            "data_replication_workspace_set": "string",
            "location_mappings": [{
                "name": "string",
                "uri_by_regions": [{
                    "region": "string",
                    "uri": "string",
                }],
            }],
        })
    
    const disasterRecoveryFailoverGroupResource = new databricks.DisasterRecoveryFailoverGroup("disasterRecoveryFailoverGroupResource", {
        failoverGroupId: "string",
        initialPrimaryRegion: "string",
        parent: "string",
        regions: ["string"],
        workspaceSets: [{
            name: "string",
            replicateWorkspaceAssets: false,
            workspaceIds: ["string"],
            stableUrlNames: ["string"],
        }],
        etag: "string",
        unityCatalogAssets: {
            catalogs: [{
                name: "string",
            }],
            dataReplicationWorkspaceSet: "string",
            locationMappings: [{
                name: "string",
                uriByRegions: [{
                    region: "string",
                    uri: "string",
                }],
            }],
        },
    });
    
    type: databricks:DisasterRecoveryFailoverGroup
    properties:
        etag: string
        failoverGroupId: string
        initialPrimaryRegion: string
        parent: string
        regions:
            - string
        unityCatalogAssets:
            catalogs:
                - name: string
            dataReplicationWorkspaceSet: string
            locationMappings:
                - name: string
                  uriByRegions:
                    - region: string
                      uri: string
        workspaceSets:
            - name: string
              replicateWorkspaceAssets: false
              stableUrlNames:
                - string
              workspaceIds:
                - string
    

    DisasterRecoveryFailoverGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DisasterRecoveryFailoverGroup resource accepts the following input properties:

    FailoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    InitialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Parent string
    The parent resource. Format: accounts/{account_id}
    Regions List<string>
    List of all regions participating in this failover group
    WorkspaceSets List<DisasterRecoveryFailoverGroupWorkspaceSet>
    Workspace sets, each containing workspaces that replicate to each other
    Etag string
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    UnityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    FailoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    InitialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Parent string
    The parent resource. Format: accounts/{account_id}
    Regions []string
    List of all regions participating in this failover group
    WorkspaceSets []DisasterRecoveryFailoverGroupWorkspaceSetArgs
    Workspace sets, each containing workspaces that replicate to each other
    Etag string
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    UnityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs
    Unity Catalog replication configuration
    failover_group_id string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initial_primary_region string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    parent string
    The parent resource. Format: accounts/{account_id}
    regions list(string)
    List of all regions participating in this failover group
    workspace_sets list(object)
    Workspace sets, each containing workspaces that replicate to each other
    etag string
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    unity_catalog_assets object
    Unity Catalog replication configuration
    failoverGroupId String
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion String
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    parent String
    The parent resource. Format: accounts/{account_id}
    regions List<String>
    List of all regions participating in this failover group
    workspaceSets List<DisasterRecoveryFailoverGroupWorkspaceSet>
    Workspace sets, each containing workspaces that replicate to each other
    etag String
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    unityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    failoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    parent string
    The parent resource. Format: accounts/{account_id}
    regions string[]
    List of all regions participating in this failover group
    workspaceSets DisasterRecoveryFailoverGroupWorkspaceSet[]
    Workspace sets, each containing workspaces that replicate to each other
    etag string
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    unityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    failover_group_id str
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initial_primary_region str
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    parent str
    The parent resource. Format: accounts/{account_id}
    regions Sequence[str]
    List of all regions participating in this failover group
    workspace_sets Sequence[DisasterRecoveryFailoverGroupWorkspaceSetArgs]
    Workspace sets, each containing workspaces that replicate to each other
    etag str
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    unity_catalog_assets DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs
    Unity Catalog replication configuration
    failoverGroupId String
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion String
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    parent String
    The parent resource. Format: accounts/{account_id}
    regions List<String>
    List of all regions participating in this failover group
    workspaceSets List<Property Map>
    Workspace sets, each containing workspaces that replicate to each other
    etag String
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    unityCatalogAssets Property Map
    Unity Catalog replication configuration

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DisasterRecoveryFailoverGroup resource produces the following output properties:

    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UpdateTime string
    (string) - Time at which this failover group was last modified
    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UpdateTime string
    (string) - Time at which this failover group was last modified
    create_time string
    (string) - Time at which this failover group was created
    effective_primary_region string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replication_point string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    update_time string
    (string) - Time at which this failover group was last modified
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    updateTime String
    (string) - Time at which this failover group was last modified
    createTime string
    (string) - Time at which this failover group was created
    effectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicationPoint string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    updateTime string
    (string) - Time at which this failover group was last modified
    create_time str
    (string) - Time at which this failover group was created
    effective_primary_region str
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replication_point str
    (string) - The latest point in time to which data has been replicated
    state str
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    update_time str
    (string) - Time at which this failover group was last modified
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    updateTime String
    (string) - Time at which this failover group was last modified

    Look up Existing DisasterRecoveryFailoverGroup Resource

    Get an existing DisasterRecoveryFailoverGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DisasterRecoveryFailoverGroupState, opts?: CustomResourceOptions): DisasterRecoveryFailoverGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            create_time: Optional[str] = None,
            effective_primary_region: Optional[str] = None,
            etag: Optional[str] = None,
            failover_group_id: Optional[str] = None,
            initial_primary_region: Optional[str] = None,
            name: Optional[str] = None,
            parent: Optional[str] = None,
            regions: Optional[Sequence[str]] = None,
            replication_point: Optional[str] = None,
            state: Optional[str] = None,
            unity_catalog_assets: Optional[DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs] = None,
            update_time: Optional[str] = None,
            workspace_sets: Optional[Sequence[DisasterRecoveryFailoverGroupWorkspaceSetArgs]] = None) -> DisasterRecoveryFailoverGroup
    func GetDisasterRecoveryFailoverGroup(ctx *Context, name string, id IDInput, state *DisasterRecoveryFailoverGroupState, opts ...ResourceOption) (*DisasterRecoveryFailoverGroup, error)
    public static DisasterRecoveryFailoverGroup Get(string name, Input<string> id, DisasterRecoveryFailoverGroupState? state, CustomResourceOptions? opts = null)
    public static DisasterRecoveryFailoverGroup get(String name, Output<String> id, DisasterRecoveryFailoverGroupState state, CustomResourceOptions options)
    resources:  _:    type: databricks:DisasterRecoveryFailoverGroup    get:      id: ${id}
    import {
      to = databricks_disasterrecoveryfailovergroup.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    FailoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    InitialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    Parent string
    The parent resource. Format: accounts/{account_id}
    Regions List<string>
    List of all regions participating in this failover group
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UnityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    UpdateTime string
    (string) - Time at which this failover group was last modified
    WorkspaceSets List<DisasterRecoveryFailoverGroupWorkspaceSet>
    Workspace sets, each containing workspaces that replicate to each other
    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    FailoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    InitialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    Parent string
    The parent resource. Format: accounts/{account_id}
    Regions []string
    List of all regions participating in this failover group
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UnityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs
    Unity Catalog replication configuration
    UpdateTime string
    (string) - Time at which this failover group was last modified
    WorkspaceSets []DisasterRecoveryFailoverGroupWorkspaceSetArgs
    Workspace sets, each containing workspaces that replicate to each other
    create_time string
    (string) - Time at which this failover group was created
    effective_primary_region string
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    failover_group_id string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initial_primary_region string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    parent string
    The parent resource. Format: accounts/{account_id}
    regions list(string)
    List of all regions participating in this failover group
    replication_point string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unity_catalog_assets object
    Unity Catalog replication configuration
    update_time string
    (string) - Time at which this failover group was last modified
    workspace_sets list(object)
    Workspace sets, each containing workspaces that replicate to each other
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    failoverGroupId String
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion String
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    parent String
    The parent resource. Format: accounts/{account_id}
    regions List<String>
    List of all regions participating in this failover group
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    updateTime String
    (string) - Time at which this failover group was last modified
    workspaceSets List<DisasterRecoveryFailoverGroupWorkspaceSet>
    Workspace sets, each containing workspaces that replicate to each other
    createTime string
    (string) - Time at which this failover group was created
    effectivePrimaryRegion string
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    failoverGroupId string
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion string
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    parent string
    The parent resource. Format: accounts/{account_id}
    regions string[]
    List of all regions participating in this failover group
    replicationPoint string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets DisasterRecoveryFailoverGroupUnityCatalogAssets
    Unity Catalog replication configuration
    updateTime string
    (string) - Time at which this failover group was last modified
    workspaceSets DisasterRecoveryFailoverGroupWorkspaceSet[]
    Workspace sets, each containing workspaces that replicate to each other
    create_time str
    (string) - Time at which this failover group was created
    effective_primary_region str
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag str
    Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    failover_group_id str
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initial_primary_region str
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name str
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    parent str
    The parent resource. Format: accounts/{account_id}
    regions Sequence[str]
    List of all regions participating in this failover group
    replication_point str
    (string) - The latest point in time to which data has been replicated
    state str
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unity_catalog_assets DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs
    Unity Catalog replication configuration
    update_time str
    (string) - Time at which this failover group was last modified
    workspace_sets Sequence[DisasterRecoveryFailoverGroupWorkspaceSetArgs]
    Workspace sets, each containing workspaces that replicate to each other
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (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, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    failoverGroupId String
    Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}
    initialPrimaryRegion String
    Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    parent String
    The parent resource. Format: accounts/{account_id}
    regions List<String>
    List of all regions participating in this failover group
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets Property Map
    Unity Catalog replication configuration
    updateTime String
    (string) - Time at which this failover group was last modified
    workspaceSets List<Property Map>
    Workspace sets, each containing workspaces that replicate to each other

    Supporting Types

    DisasterRecoveryFailoverGroupUnityCatalogAssets, DisasterRecoveryFailoverGroupUnityCatalogAssetsArgs

    Catalogs List<DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog>
    UC catalogs to replicate
    DataReplicationWorkspaceSet string
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    LocationMappings List<DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping>
    Location mappings - storage URI per region for each location
    Catalogs []DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog
    UC catalogs to replicate
    DataReplicationWorkspaceSet string
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    LocationMappings []DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping
    Location mappings - storage URI per region for each location
    catalogs list(object)
    UC catalogs to replicate
    data_replication_workspace_set string
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    location_mappings list(object)
    Location mappings - storage URI per region for each location
    catalogs List<DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog>
    UC catalogs to replicate
    dataReplicationWorkspaceSet String
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings List<DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping>
    Location mappings - storage URI per region for each location
    catalogs DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog[]
    UC catalogs to replicate
    dataReplicationWorkspaceSet string
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping[]
    Location mappings - storage URI per region for each location
    catalogs Sequence[DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog]
    UC catalogs to replicate
    data_replication_workspace_set str
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    location_mappings Sequence[DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping]
    Location mappings - storage URI per region for each location
    catalogs List<Property Map>
    UC catalogs to replicate
    dataReplicationWorkspaceSet String
    The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings List<Property Map>
    Location mappings - storage URI per region for each location

    DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog, DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalogArgs

    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name str
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}

    DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping, DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingArgs

    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    UriByRegions List<DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion>
    URI for each region. Each entry maps a region name to a storage URI
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    UriByRegions []DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion
    URI for each region. Each entry maps a region name to a storage URI
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uri_by_regions list(object)
    URI for each region. Each entry maps a region name to a storage URI
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions List<DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion>
    URI for each region. Each entry maps a region name to a storage URI
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion[]
    URI for each region. Each entry maps a region name to a storage URI
    name str
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uri_by_regions Sequence[DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion]
    URI for each region. Each entry maps a region name to a storage URI
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions List<Property Map>
    URI for each region. Each entry maps a region name to a storage URI

    DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion, DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegionArgs

    Region string
    The region name
    Uri string
    The storage URI for this region
    Region string
    The region name
    Uri string
    The storage URI for this region
    region string
    The region name
    uri string
    The storage URI for this region
    region String
    The region name
    uri String
    The storage URI for this region
    region string
    The region name
    uri string
    The storage URI for this region
    region str
    The region name
    uri str
    The storage URI for this region
    region String
    The region name
    uri String
    The storage URI for this region

    DisasterRecoveryFailoverGroupWorkspaceSet, DisasterRecoveryFailoverGroupWorkspaceSetArgs

    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicateWorkspaceAssets bool
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    WorkspaceIds List<string>
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    StableUrlNames List<string>
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    Name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicateWorkspaceAssets bool
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    WorkspaceIds []string
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    StableUrlNames []string
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicate_workspace_assets bool
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspace_ids list(string)
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stable_url_names list(string)
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets Boolean
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds List<String>
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames List<String>
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name string
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets boolean
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds string[]
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames string[]
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name str
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicate_workspace_assets bool
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspace_ids Sequence[str]
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stable_url_names Sequence[str]
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name String
    (string) - Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets Boolean
    Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds List<String>
    Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames List<String>
    Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.94.0
    published on Friday, May 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial