1. Packages
  2. Databricks Provider
  3. API Docs
  4. AutomaticClusterUpdateWorkspaceSetting
Databricks v1.65.0 published on Wednesday, Apr 9, 2025 by Pulumi

databricks.AutomaticClusterUpdateWorkspaceSetting

Explore with Pulumi AI

Create AutomaticClusterUpdateWorkspaceSetting Resource

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

Constructor syntax

new AutomaticClusterUpdateWorkspaceSetting(name: string, args: AutomaticClusterUpdateWorkspaceSettingArgs, opts?: CustomResourceOptions);
@overload
def AutomaticClusterUpdateWorkspaceSetting(resource_name: str,
                                           args: AutomaticClusterUpdateWorkspaceSettingArgs,
                                           opts: Optional[ResourceOptions] = None)

@overload
def AutomaticClusterUpdateWorkspaceSetting(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           automatic_cluster_update_workspace: Optional[AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs] = None,
                                           etag: Optional[str] = None,
                                           setting_name: Optional[str] = None)
func NewAutomaticClusterUpdateWorkspaceSetting(ctx *Context, name string, args AutomaticClusterUpdateWorkspaceSettingArgs, opts ...ResourceOption) (*AutomaticClusterUpdateWorkspaceSetting, error)
public AutomaticClusterUpdateWorkspaceSetting(string name, AutomaticClusterUpdateWorkspaceSettingArgs args, CustomResourceOptions? opts = null)
public AutomaticClusterUpdateWorkspaceSetting(String name, AutomaticClusterUpdateWorkspaceSettingArgs args)
public AutomaticClusterUpdateWorkspaceSetting(String name, AutomaticClusterUpdateWorkspaceSettingArgs args, CustomResourceOptions options)
type: databricks:AutomaticClusterUpdateWorkspaceSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AutomaticClusterUpdateWorkspaceSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AutomaticClusterUpdateWorkspaceSettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AutomaticClusterUpdateWorkspaceSettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AutomaticClusterUpdateWorkspaceSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AutomaticClusterUpdateWorkspaceSettingArgs
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 automaticClusterUpdateWorkspaceSettingResource = new Databricks.AutomaticClusterUpdateWorkspaceSetting("automaticClusterUpdateWorkspaceSettingResource", new()
{
    AutomaticClusterUpdateWorkspace = new Databricks.Inputs.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs
    {
        Enabled = false,
        CanToggle = false,
        EnablementDetails = new Databricks.Inputs.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetailsArgs
        {
            ForcedForComplianceMode = false,
            UnavailableForDisabledEntitlement = false,
            UnavailableForNonEnterpriseTier = false,
        },
        MaintenanceWindow = new Databricks.Inputs.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowArgs
        {
            WeekDayBasedSchedule = new Databricks.Inputs.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleArgs
            {
                DayOfWeek = "string",
                Frequency = "string",
                WindowStartTime = new Databricks.Inputs.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTimeArgs
                {
                    Hours = 0,
                    Minutes = 0,
                },
            },
        },
        RestartEvenIfNoUpdatesAvailable = false,
    },
    Etag = "string",
    SettingName = "string",
});
Copy
example, err := databricks.NewAutomaticClusterUpdateWorkspaceSetting(ctx, "automaticClusterUpdateWorkspaceSettingResource", &databricks.AutomaticClusterUpdateWorkspaceSettingArgs{
	AutomaticClusterUpdateWorkspace: &databricks.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs{
		Enabled:   pulumi.Bool(false),
		CanToggle: pulumi.Bool(false),
		EnablementDetails: &databricks.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetailsArgs{
			ForcedForComplianceMode:           pulumi.Bool(false),
			UnavailableForDisabledEntitlement: pulumi.Bool(false),
			UnavailableForNonEnterpriseTier:   pulumi.Bool(false),
		},
		MaintenanceWindow: &databricks.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowArgs{
			WeekDayBasedSchedule: &databricks.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleArgs{
				DayOfWeek: pulumi.String("string"),
				Frequency: pulumi.String("string"),
				WindowStartTime: &databricks.AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTimeArgs{
					Hours:   pulumi.Int(0),
					Minutes: pulumi.Int(0),
				},
			},
		},
		RestartEvenIfNoUpdatesAvailable: pulumi.Bool(false),
	},
	Etag:        pulumi.String("string"),
	SettingName: pulumi.String("string"),
})
Copy
var automaticClusterUpdateWorkspaceSettingResource = new AutomaticClusterUpdateWorkspaceSetting("automaticClusterUpdateWorkspaceSettingResource", AutomaticClusterUpdateWorkspaceSettingArgs.builder()
    .automaticClusterUpdateWorkspace(AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs.builder()
        .enabled(false)
        .canToggle(false)
        .enablementDetails(AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetailsArgs.builder()
            .forcedForComplianceMode(false)
            .unavailableForDisabledEntitlement(false)
            .unavailableForNonEnterpriseTier(false)
            .build())
        .maintenanceWindow(AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowArgs.builder()
            .weekDayBasedSchedule(AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleArgs.builder()
                .dayOfWeek("string")
                .frequency("string")
                .windowStartTime(AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTimeArgs.builder()
                    .hours(0)
                    .minutes(0)
                    .build())
                .build())
            .build())
        .restartEvenIfNoUpdatesAvailable(false)
        .build())
    .etag("string")
    .settingName("string")
    .build());
Copy
automatic_cluster_update_workspace_setting_resource = databricks.AutomaticClusterUpdateWorkspaceSetting("automaticClusterUpdateWorkspaceSettingResource",
    automatic_cluster_update_workspace={
        "enabled": False,
        "can_toggle": False,
        "enablement_details": {
            "forced_for_compliance_mode": False,
            "unavailable_for_disabled_entitlement": False,
            "unavailable_for_non_enterprise_tier": False,
        },
        "maintenance_window": {
            "week_day_based_schedule": {
                "day_of_week": "string",
                "frequency": "string",
                "window_start_time": {
                    "hours": 0,
                    "minutes": 0,
                },
            },
        },
        "restart_even_if_no_updates_available": False,
    },
    etag="string",
    setting_name="string")
Copy
const automaticClusterUpdateWorkspaceSettingResource = new databricks.AutomaticClusterUpdateWorkspaceSetting("automaticClusterUpdateWorkspaceSettingResource", {
    automaticClusterUpdateWorkspace: {
        enabled: false,
        canToggle: false,
        enablementDetails: {
            forcedForComplianceMode: false,
            unavailableForDisabledEntitlement: false,
            unavailableForNonEnterpriseTier: false,
        },
        maintenanceWindow: {
            weekDayBasedSchedule: {
                dayOfWeek: "string",
                frequency: "string",
                windowStartTime: {
                    hours: 0,
                    minutes: 0,
                },
            },
        },
        restartEvenIfNoUpdatesAvailable: false,
    },
    etag: "string",
    settingName: "string",
});
Copy
type: databricks:AutomaticClusterUpdateWorkspaceSetting
properties:
    automaticClusterUpdateWorkspace:
        canToggle: false
        enabled: false
        enablementDetails:
            forcedForComplianceMode: false
            unavailableForDisabledEntitlement: false
            unavailableForNonEnterpriseTier: false
        maintenanceWindow:
            weekDayBasedSchedule:
                dayOfWeek: string
                frequency: string
                windowStartTime:
                    hours: 0
                    minutes: 0
        restartEvenIfNoUpdatesAvailable: false
    etag: string
    settingName: string
Copy

AutomaticClusterUpdateWorkspaceSetting 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 AutomaticClusterUpdateWorkspaceSetting resource accepts the following input properties:

automaticClusterUpdateWorkspace This property is required. Property Map
etag String
settingName String

Outputs

All input properties are implicitly available as output properties. Additionally, the AutomaticClusterUpdateWorkspaceSetting 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 AutomaticClusterUpdateWorkspaceSetting Resource

Get an existing AutomaticClusterUpdateWorkspaceSetting 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?: AutomaticClusterUpdateWorkspaceSettingState, opts?: CustomResourceOptions): AutomaticClusterUpdateWorkspaceSetting
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automatic_cluster_update_workspace: Optional[AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs] = None,
        etag: Optional[str] = None,
        setting_name: Optional[str] = None) -> AutomaticClusterUpdateWorkspaceSetting
func GetAutomaticClusterUpdateWorkspaceSetting(ctx *Context, name string, id IDInput, state *AutomaticClusterUpdateWorkspaceSettingState, opts ...ResourceOption) (*AutomaticClusterUpdateWorkspaceSetting, error)
public static AutomaticClusterUpdateWorkspaceSetting Get(string name, Input<string> id, AutomaticClusterUpdateWorkspaceSettingState? state, CustomResourceOptions? opts = null)
public static AutomaticClusterUpdateWorkspaceSetting get(String name, Output<String> id, AutomaticClusterUpdateWorkspaceSettingState state, CustomResourceOptions options)
resources:  _:    type: databricks:AutomaticClusterUpdateWorkspaceSetting    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Supporting Types

AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace
, AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceArgs

AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetails
, AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetailsArgs

AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindow
, AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowArgs

AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule
, AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleArgs

dayOfWeek This property is required. String
frequency This property is required. String
windowStartTime Property Map

AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime
, AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTimeArgs

Hours This property is required. int
Minutes This property is required. int
Hours This property is required. int
Minutes This property is required. int
hours This property is required. Integer
minutes This property is required. Integer
hours This property is required. number
minutes This property is required. number
hours This property is required. int
minutes This property is required. int
hours This property is required. Number
minutes This property is required. Number

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes
This Pulumi package is based on the databricks Terraform Provider.