@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
275 lines (274 loc) • 16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* Setting is a configurable value or control that determines how a feature or behavior works within the databricks platform.
*
* [//]: # (todo: add public link to metadata api after production doc link available)
* See settings-metadata api for list of settings that can be modified using this resource.
*
* ## Example Usage
*
* Getting an account level setting:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.AccountSettingV2("this", {
* name: "llm_proxy_partner_powered",
* booleanVal: {
* value: false,
* },
* });
* ```
*
* ## Import
*
* As of Pulumi v1.5, resources can be imported through configuration.
*
* hcl
*
* import {
*
* id = "name"
*
* to = databricks_account_setting_v2.this
*
* }
*
* If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
*
* ```sh
* $ pulumi import databricks:index/accountSettingV2:AccountSettingV2 this "name"
* ```
*/
export declare class AccountSettingV2 extends pulumi.CustomResource {
/**
* Get an existing AccountSettingV2 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?: AccountSettingV2State, opts?: pulumi.CustomResourceOptions): AccountSettingV2;
/**
* Returns true if the given object is an instance of AccountSettingV2. 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 AccountSettingV2;
/**
* Setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingAccessPolicy for final setting value
*/
readonly aibiDashboardEmbeddingAccessPolicy: pulumi.Output<outputs.AccountSettingV2AibiDashboardEmbeddingAccessPolicy | undefined>;
/**
* Setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingApprovedDomains for final setting value
*/
readonly aibiDashboardEmbeddingApprovedDomains: pulumi.Output<outputs.AccountSettingV2AibiDashboardEmbeddingApprovedDomains | undefined>;
/**
* Setting value for automaticClusterUpdateWorkspace setting. This is the setting value set by consumers, check effectiveAutomaticClusterUpdateWorkspace for final setting value
*/
readonly automaticClusterUpdateWorkspace: pulumi.Output<outputs.AccountSettingV2AutomaticClusterUpdateWorkspace | undefined>;
/**
* Setting value for boolean type setting. This is the setting value set by consumers, check effectiveBooleanVal for final setting value
*/
readonly booleanVal: pulumi.Output<outputs.AccountSettingV2BooleanVal | undefined>;
/**
* Effective setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy
*/
readonly effectiveAibiDashboardEmbeddingAccessPolicy: pulumi.Output<outputs.AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy | undefined>;
/**
* Effective setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains
*/
readonly effectiveAibiDashboardEmbeddingApprovedDomains: pulumi.Output<outputs.AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains | undefined>;
/**
* Effective setting value for automaticClusterUpdateWorkspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace
*/
readonly effectiveAutomaticClusterUpdateWorkspace: pulumi.Output<outputs.AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace | undefined>;
/**
* (BooleanMessage) - Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val
*/
readonly effectiveBooleanVal: pulumi.Output<outputs.AccountSettingV2EffectiveBooleanVal>;
/**
* (IntegerMessage) - Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val
*/
readonly effectiveIntegerVal: pulumi.Output<outputs.AccountSettingV2EffectiveIntegerVal>;
/**
* Effective setting value for personalCompute setting. This is the final effective value of setting. To set a value use personal_compute
*/
readonly effectivePersonalCompute: pulumi.Output<outputs.AccountSettingV2EffectivePersonalCompute | undefined>;
/**
* Effective setting value for restrictWorkspaceAdmins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins
*/
readonly effectiveRestrictWorkspaceAdmins: pulumi.Output<outputs.AccountSettingV2EffectiveRestrictWorkspaceAdmins | undefined>;
/**
* (StringMessage) - Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val
*/
readonly effectiveStringVal: pulumi.Output<outputs.AccountSettingV2EffectiveStringVal>;
/**
* Setting value for integer type setting. This is the setting value set by consumers, check effectiveIntegerVal for final setting value
*/
readonly integerVal: pulumi.Output<outputs.AccountSettingV2IntegerVal | undefined>;
/**
* Name of the setting
*/
readonly name: pulumi.Output<string>;
/**
* Setting value for personalCompute setting. This is the setting value set by consumers, check effectivePersonalCompute for final setting value
*/
readonly personalCompute: pulumi.Output<outputs.AccountSettingV2PersonalCompute | undefined>;
/**
* Setting value for restrictWorkspaceAdmins setting. This is the setting value set by consumers, check effectiveRestrictWorkspaceAdmins for final setting value
*/
readonly restrictWorkspaceAdmins: pulumi.Output<outputs.AccountSettingV2RestrictWorkspaceAdmins | undefined>;
/**
* Setting value for string type setting. This is the setting value set by consumers, check effectiveStringVal for final setting value
*/
readonly stringVal: pulumi.Output<outputs.AccountSettingV2StringVal | undefined>;
/**
* Create a AccountSettingV2 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?: AccountSettingV2Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccountSettingV2 resources.
*/
export interface AccountSettingV2State {
/**
* Setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingAccessPolicy for final setting value
*/
aibiDashboardEmbeddingAccessPolicy?: pulumi.Input<inputs.AccountSettingV2AibiDashboardEmbeddingAccessPolicy>;
/**
* Setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingApprovedDomains for final setting value
*/
aibiDashboardEmbeddingApprovedDomains?: pulumi.Input<inputs.AccountSettingV2AibiDashboardEmbeddingApprovedDomains>;
/**
* Setting value for automaticClusterUpdateWorkspace setting. This is the setting value set by consumers, check effectiveAutomaticClusterUpdateWorkspace for final setting value
*/
automaticClusterUpdateWorkspace?: pulumi.Input<inputs.AccountSettingV2AutomaticClusterUpdateWorkspace>;
/**
* Setting value for boolean type setting. This is the setting value set by consumers, check effectiveBooleanVal for final setting value
*/
booleanVal?: pulumi.Input<inputs.AccountSettingV2BooleanVal>;
/**
* Effective setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy
*/
effectiveAibiDashboardEmbeddingAccessPolicy?: pulumi.Input<inputs.AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy>;
/**
* Effective setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains
*/
effectiveAibiDashboardEmbeddingApprovedDomains?: pulumi.Input<inputs.AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains>;
/**
* Effective setting value for automaticClusterUpdateWorkspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace
*/
effectiveAutomaticClusterUpdateWorkspace?: pulumi.Input<inputs.AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace>;
/**
* (BooleanMessage) - Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val
*/
effectiveBooleanVal?: pulumi.Input<inputs.AccountSettingV2EffectiveBooleanVal>;
/**
* (IntegerMessage) - Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val
*/
effectiveIntegerVal?: pulumi.Input<inputs.AccountSettingV2EffectiveIntegerVal>;
/**
* Effective setting value for personalCompute setting. This is the final effective value of setting. To set a value use personal_compute
*/
effectivePersonalCompute?: pulumi.Input<inputs.AccountSettingV2EffectivePersonalCompute>;
/**
* Effective setting value for restrictWorkspaceAdmins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins
*/
effectiveRestrictWorkspaceAdmins?: pulumi.Input<inputs.AccountSettingV2EffectiveRestrictWorkspaceAdmins>;
/**
* (StringMessage) - Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val
*/
effectiveStringVal?: pulumi.Input<inputs.AccountSettingV2EffectiveStringVal>;
/**
* Setting value for integer type setting. This is the setting value set by consumers, check effectiveIntegerVal for final setting value
*/
integerVal?: pulumi.Input<inputs.AccountSettingV2IntegerVal>;
/**
* Name of the setting
*/
name?: pulumi.Input<string>;
/**
* Setting value for personalCompute setting. This is the setting value set by consumers, check effectivePersonalCompute for final setting value
*/
personalCompute?: pulumi.Input<inputs.AccountSettingV2PersonalCompute>;
/**
* Setting value for restrictWorkspaceAdmins setting. This is the setting value set by consumers, check effectiveRestrictWorkspaceAdmins for final setting value
*/
restrictWorkspaceAdmins?: pulumi.Input<inputs.AccountSettingV2RestrictWorkspaceAdmins>;
/**
* Setting value for string type setting. This is the setting value set by consumers, check effectiveStringVal for final setting value
*/
stringVal?: pulumi.Input<inputs.AccountSettingV2StringVal>;
}
/**
* The set of arguments for constructing a AccountSettingV2 resource.
*/
export interface AccountSettingV2Args {
/**
* Setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingAccessPolicy for final setting value
*/
aibiDashboardEmbeddingAccessPolicy?: pulumi.Input<inputs.AccountSettingV2AibiDashboardEmbeddingAccessPolicy>;
/**
* Setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the setting value set by consumers, check effectiveAibiDashboardEmbeddingApprovedDomains for final setting value
*/
aibiDashboardEmbeddingApprovedDomains?: pulumi.Input<inputs.AccountSettingV2AibiDashboardEmbeddingApprovedDomains>;
/**
* Setting value for automaticClusterUpdateWorkspace setting. This is the setting value set by consumers, check effectiveAutomaticClusterUpdateWorkspace for final setting value
*/
automaticClusterUpdateWorkspace?: pulumi.Input<inputs.AccountSettingV2AutomaticClusterUpdateWorkspace>;
/**
* Setting value for boolean type setting. This is the setting value set by consumers, check effectiveBooleanVal for final setting value
*/
booleanVal?: pulumi.Input<inputs.AccountSettingV2BooleanVal>;
/**
* Effective setting value for aibiDashboardEmbeddingAccessPolicy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy
*/
effectiveAibiDashboardEmbeddingAccessPolicy?: pulumi.Input<inputs.AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy>;
/**
* Effective setting value for aibiDashboardEmbeddingApprovedDomains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains
*/
effectiveAibiDashboardEmbeddingApprovedDomains?: pulumi.Input<inputs.AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains>;
/**
* Effective setting value for automaticClusterUpdateWorkspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace
*/
effectiveAutomaticClusterUpdateWorkspace?: pulumi.Input<inputs.AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace>;
/**
* Effective setting value for personalCompute setting. This is the final effective value of setting. To set a value use personal_compute
*/
effectivePersonalCompute?: pulumi.Input<inputs.AccountSettingV2EffectivePersonalCompute>;
/**
* Effective setting value for restrictWorkspaceAdmins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins
*/
effectiveRestrictWorkspaceAdmins?: pulumi.Input<inputs.AccountSettingV2EffectiveRestrictWorkspaceAdmins>;
/**
* Setting value for integer type setting. This is the setting value set by consumers, check effectiveIntegerVal for final setting value
*/
integerVal?: pulumi.Input<inputs.AccountSettingV2IntegerVal>;
/**
* Name of the setting
*/
name?: pulumi.Input<string>;
/**
* Setting value for personalCompute setting. This is the setting value set by consumers, check effectivePersonalCompute for final setting value
*/
personalCompute?: pulumi.Input<inputs.AccountSettingV2PersonalCompute>;
/**
* Setting value for restrictWorkspaceAdmins setting. This is the setting value set by consumers, check effectiveRestrictWorkspaceAdmins for final setting value
*/
restrictWorkspaceAdmins?: pulumi.Input<inputs.AccountSettingV2RestrictWorkspaceAdmins>;
/**
* Setting value for string type setting. This is the setting value set by consumers, check effectiveStringVal for final setting value
*/
stringVal?: pulumi.Input<inputs.AccountSettingV2StringVal>;
}