@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
103 lines (102 loc) • 3.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html).
*
* > This resource can only be used with a workspace-level provider!
*
* > Certain system schemas (such as `billing`) may be auto-enabled once GA and should not be manually declared in Pulumi configurations.
*
* Manages system tables enablement. System tables are a Databricks-hosted analytical store of your account’s operational data. System tables can be used for historical observability across your account. System tables must be enabled by an account admin.
*
* ## Example Usage
*
* Enable the system schema `access`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.SystemSchema("this", {schema: "access"});
* ```
*
* ## Import
*
* This resource can be imported by the metastore id and schema name
*
* bash
*
* ```sh
* $ pulumi import databricks:index/systemSchema:SystemSchema this '<metastore_id>|<schema_name>'
* ```
*/
export declare class SystemSchema extends pulumi.CustomResource {
/**
* Get an existing SystemSchema 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?: SystemSchemaState, opts?: pulumi.CustomResourceOptions): SystemSchema;
/**
* Returns true if the given object is an instance of SystemSchema. 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 SystemSchema;
readonly autoEnabled: pulumi.Output<boolean>;
/**
* the full name of the system schema, in form of `system.<schema>`.
*/
readonly fullName: pulumi.Output<string>;
readonly metastoreId: pulumi.Output<string>;
/**
* name of the system schema.
*/
readonly schema: pulumi.Output<string | undefined>;
/**
* The current state of enablement for the system schema.
*/
readonly state: pulumi.Output<string>;
/**
* Create a SystemSchema 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?: SystemSchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SystemSchema resources.
*/
export interface SystemSchemaState {
autoEnabled?: pulumi.Input<boolean>;
/**
* the full name of the system schema, in form of `system.<schema>`.
*/
fullName?: pulumi.Input<string>;
metastoreId?: pulumi.Input<string>;
/**
* name of the system schema.
*/
schema?: pulumi.Input<string>;
/**
* The current state of enablement for the system schema.
*/
state?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SystemSchema resource.
*/
export interface SystemSchemaArgs {
/**
* name of the system schema.
*/
schema?: pulumi.Input<string>;
/**
* The current state of enablement for the system schema.
*/
state?: pulumi.Input<string>;
}