databricks.DisableLegacyAccessSetting
Explore with Pulumi AI
The databricks.DisableLegacyAccessSetting
resource allows you to disable legacy access. It has the following impact:
- Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation.
- Disables Fallback Mode on any External Location access from the workspace.
- Disables Databricks Runtime versions prior to 13.3LTS.
This resource can only be used with a workspace-level provider!
It may take 5 minutes to take effect and requires a restart of clusters and SQL warehouses.
Please also set the default namespace using databricks.DefaultNamespaceSetting to any value other than
hive_metastore
to avoid potential issues.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = new databricks.DisableLegacyAccessSetting("this", {disableLegacyAccess: {
value: true,
}});
import pulumi
import pulumi_databricks as databricks
this = databricks.DisableLegacyAccessSetting("this", disable_legacy_access={
"value": True,
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewDisableLegacyAccessSetting(ctx, "this", &databricks.DisableLegacyAccessSettingArgs{
DisableLegacyAccess: &databricks.DisableLegacyAccessSettingDisableLegacyAccessArgs{
Value: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = new Databricks.DisableLegacyAccessSetting("this", new()
{
DisableLegacyAccess = new Databricks.Inputs.DisableLegacyAccessSettingDisableLegacyAccessArgs
{
Value = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DisableLegacyAccessSetting;
import com.pulumi.databricks.DisableLegacyAccessSettingArgs;
import com.pulumi.databricks.inputs.DisableLegacyAccessSettingDisableLegacyAccessArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var this_ = new DisableLegacyAccessSetting("this", DisableLegacyAccessSettingArgs.builder()
.disableLegacyAccess(DisableLegacyAccessSettingDisableLegacyAccessArgs.builder()
.value(true)
.build())
.build());
}
}
resources:
this:
type: databricks:DisableLegacyAccessSetting
properties:
disableLegacyAccess:
value: true
Create DisableLegacyAccessSetting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DisableLegacyAccessSetting(name: string, args: DisableLegacyAccessSettingArgs, opts?: CustomResourceOptions);
@overload
def DisableLegacyAccessSetting(resource_name: str,
args: DisableLegacyAccessSettingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DisableLegacyAccessSetting(resource_name: str,
opts: Optional[ResourceOptions] = None,
disable_legacy_access: Optional[DisableLegacyAccessSettingDisableLegacyAccessArgs] = None,
etag: Optional[str] = None,
setting_name: Optional[str] = None)
func NewDisableLegacyAccessSetting(ctx *Context, name string, args DisableLegacyAccessSettingArgs, opts ...ResourceOption) (*DisableLegacyAccessSetting, error)
public DisableLegacyAccessSetting(string name, DisableLegacyAccessSettingArgs args, CustomResourceOptions? opts = null)
public DisableLegacyAccessSetting(String name, DisableLegacyAccessSettingArgs args)
public DisableLegacyAccessSetting(String name, DisableLegacyAccessSettingArgs args, CustomResourceOptions options)
type: databricks:DisableLegacyAccessSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DisableLegacyAccessSettingArgs
- 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 DisableLegacyAccessSettingArgs
- 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 DisableLegacyAccessSettingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DisableLegacyAccessSettingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DisableLegacyAccessSettingArgs
- 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 disableLegacyAccessSettingResource = new Databricks.DisableLegacyAccessSetting("disableLegacyAccessSettingResource", new()
{
DisableLegacyAccess = new Databricks.Inputs.DisableLegacyAccessSettingDisableLegacyAccessArgs
{
Value = false,
},
Etag = "string",
SettingName = "string",
});
example, err := databricks.NewDisableLegacyAccessSetting(ctx, "disableLegacyAccessSettingResource", &databricks.DisableLegacyAccessSettingArgs{
DisableLegacyAccess: &databricks.DisableLegacyAccessSettingDisableLegacyAccessArgs{
Value: pulumi.Bool(false),
},
Etag: pulumi.String("string"),
SettingName: pulumi.String("string"),
})
var disableLegacyAccessSettingResource = new DisableLegacyAccessSetting("disableLegacyAccessSettingResource", DisableLegacyAccessSettingArgs.builder()
.disableLegacyAccess(DisableLegacyAccessSettingDisableLegacyAccessArgs.builder()
.value(false)
.build())
.etag("string")
.settingName("string")
.build());
disable_legacy_access_setting_resource = databricks.DisableLegacyAccessSetting("disableLegacyAccessSettingResource",
disable_legacy_access={
"value": False,
},
etag="string",
setting_name="string")
const disableLegacyAccessSettingResource = new databricks.DisableLegacyAccessSetting("disableLegacyAccessSettingResource", {
disableLegacyAccess: {
value: false,
},
etag: "string",
settingName: "string",
});
type: databricks:DisableLegacyAccessSetting
properties:
disableLegacyAccess:
value: false
etag: string
settingName: string
DisableLegacyAccessSetting 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 DisableLegacyAccessSetting resource accepts the following input properties:
- Disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- Etag string
- Setting
Name string
- Disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access Args - The configuration details.
- Etag string
- Setting
Name string
- disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- etag String
- setting
Name String
- disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- etag string
- setting
Name string
- disable_
legacy_ Disableaccess Legacy Access Setting Disable Legacy Access Args - The configuration details.
- etag str
- setting_
name str
- disable
Legacy Property MapAccess - The configuration details.
- etag String
- setting
Name String
Outputs
All input properties are implicitly available as output properties. Additionally, the DisableLegacyAccessSetting resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DisableLegacyAccessSetting Resource
Get an existing DisableLegacyAccessSetting 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?: DisableLegacyAccessSettingState, opts?: CustomResourceOptions): DisableLegacyAccessSetting
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
disable_legacy_access: Optional[DisableLegacyAccessSettingDisableLegacyAccessArgs] = None,
etag: Optional[str] = None,
setting_name: Optional[str] = None) -> DisableLegacyAccessSetting
func GetDisableLegacyAccessSetting(ctx *Context, name string, id IDInput, state *DisableLegacyAccessSettingState, opts ...ResourceOption) (*DisableLegacyAccessSetting, error)
public static DisableLegacyAccessSetting Get(string name, Input<string> id, DisableLegacyAccessSettingState? state, CustomResourceOptions? opts = null)
public static DisableLegacyAccessSetting get(String name, Output<String> id, DisableLegacyAccessSettingState state, CustomResourceOptions options)
resources: _: type: databricks:DisableLegacyAccessSetting get: 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.
- Disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- Etag string
- Setting
Name string
- Disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access Args - The configuration details.
- Etag string
- Setting
Name string
- disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- etag String
- setting
Name String
- disable
Legacy DisableAccess Legacy Access Setting Disable Legacy Access - The configuration details.
- etag string
- setting
Name string
- disable_
legacy_ Disableaccess Legacy Access Setting Disable Legacy Access Args - The configuration details.
- etag str
- setting_
name str
- disable
Legacy Property MapAccess - The configuration details.
- etag String
- setting
Name String
Supporting Types
DisableLegacyAccessSettingDisableLegacyAccess, DisableLegacyAccessSettingDisableLegacyAccessArgs
- Value bool
- The boolean value for the setting.
- Value bool
- The boolean value for the setting.
- value Boolean
- The boolean value for the setting.
- value boolean
- The boolean value for the setting.
- value bool
- The boolean value for the setting.
- value Boolean
- The boolean value for the setting.
Import
This resource can be imported by predefined name global
:
bash
$ pulumi import databricks:index/disableLegacyAccessSetting:DisableLegacyAccessSetting this global
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.