@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
85 lines (84 loc) • 4.87 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > This resource has an evolving API, which may change in future versions of the provider.
*
* Manages workspace configuration for expert usage. Currently, more than one instance of resource can exist in Pulumi state, though there's no deterministic behavior, when they manage the same property. We strongly recommend to use a single `databricks.WorkspaceConf` per workspace.
*
* > Deleting `databricks.WorkspaceConf` resources may fail depending on the configuration properties set, including but not limited to `enableIpAccessLists`, `enableGp3`, and `maxTokenLifetimeDays`. The provider will print a warning if this occurs. You can verify the workspace configuration by reviewing [the workspace settings in the UI](https://docs.databricks.com/en/admin/workspace-settings/index.html).
*
* ## Example Usage
*
* Allows specification of custom configuration properties for expert usage:
*
* - `enableIpAccessLists` - enables the use of databricks.IpAccessList resources
* - `maxTokenLifetimeDays` - (string) Maximum token lifetime of new tokens in days, as an integer. This value can range from 1 day to 730 days (2 years). If not specified, the maximum lifetime of new tokens is 730 days. **WARNING:** This limit only applies to new tokens, so there may be tokens with lifetimes longer than this value, including unlimited lifetime. Such tokens may have been created before the current maximum token lifetime was set.
* - `enableTokensConfig` - (boolean) Enable or disable personal access tokens for this workspace.
* - `enableDeprecatedClusterNamedInitScripts` - (boolean) Enable or disable [legacy cluster-named init scripts](https://docs.databricks.com/clusters/init-scripts.html#disable-legacy-cluster-named-init-scripts-for-a-workspace) for this workspace.
* - `enableDeprecatedGlobalInitScripts` - (boolean) Enable or disable [legacy global init scripts](https://docs.databricks.com/clusters/init-scripts.html#migrate-legacy-scripts) for this workspace.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.WorkspaceConf("this", {customConfig: {
* enableIpAccessLists: "true",
* }});
* ```
*
* ## Import
*
* !> Importing this resource is not currently supported.
*/
export declare class WorkspaceConf extends pulumi.CustomResource {
/**
* Get an existing WorkspaceConf resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkspaceConfState, opts?: pulumi.CustomResourceOptions): WorkspaceConf;
/**
* Returns true if the given object is an instance of WorkspaceConf. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is WorkspaceConf;
/**
* Key-value map of strings that represent workspace configuration. Upon resource deletion, properties that start with `enable` or `enforce` will be reset to `false` value, regardless of initial default one.
*/
readonly customConfig: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Create a WorkspaceConf resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: WorkspaceConfArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering WorkspaceConf resources.
*/
export interface WorkspaceConfState {
/**
* Key-value map of strings that represent workspace configuration. Upon resource deletion, properties that start with `enable` or `enforce` will be reset to `false` value, regardless of initial default one.
*/
customConfig?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a WorkspaceConf resource.
*/
export interface WorkspaceConfArgs {
/**
* Key-value map of strings that represent workspace configuration. Upon resource deletion, properties that start with `enable` or `enforce` will be reset to `false` value, regardless of initial default one.
*/
customConfig?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}