@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
121 lines (120 loc) • 4.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > This resource can only be used with a workspace-level provider!
*
* In Delta Sharing, a provider is an entity that shares data with a recipient. Within a metastore, Unity Catalog provides the ability to create a provider which contains a list of shares that have been shared with you.
*
* A `databricks.MetastoreProvider` is contained within databricks.Metastore and can contain a list of shares that have been shared with you.
*
* > Databricks to Databricks sharing automatically creates the provider.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const dbprovider = new databricks.MetastoreProvider("dbprovider", {
* name: "terraform-test-provider",
* comment: "made by terraform 2",
* authenticationType: "TOKEN",
* recipientProfileStr: JSON.stringify({
* shareCredentialsVersion: 1,
* bearerToken: "token",
* endpoint: "endpoint",
* expirationTime: "expiration-time",
* }),
* });
* ```
*
* ## Related Resources
*
* The following resources are used in the same context:
*
* * databricks.getTables data to list tables within Unity Catalog.
* * databricks.getSchemas data to list schemas within Unity Catalog.
* * databricks.getCatalogs data to list catalogs within Unity Catalog.
*/
export declare class MetastoreProvider extends pulumi.CustomResource {
/**
* Get an existing MetastoreProvider 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?: MetastoreProviderState, opts?: pulumi.CustomResourceOptions): MetastoreProvider;
/**
* Returns true if the given object is an instance of MetastoreProvider. 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 MetastoreProvider;
/**
* The delta sharing authentication type. Valid values are `TOKEN`.
*/
readonly authenticationType: pulumi.Output<string>;
/**
* Description about the provider.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* Name of provider. Change forces creation of a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* This is the json file that is created from a recipient url.
*/
readonly recipientProfileStr: pulumi.Output<string>;
/**
* Create a MetastoreProvider 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: MetastoreProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetastoreProvider resources.
*/
export interface MetastoreProviderState {
/**
* The delta sharing authentication type. Valid values are `TOKEN`.
*/
authenticationType?: pulumi.Input<string>;
/**
* Description about the provider.
*/
comment?: pulumi.Input<string>;
/**
* Name of provider. Change forces creation of a new resource.
*/
name?: pulumi.Input<string>;
/**
* This is the json file that is created from a recipient url.
*/
recipientProfileStr?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetastoreProvider resource.
*/
export interface MetastoreProviderArgs {
/**
* The delta sharing authentication type. Valid values are `TOKEN`.
*/
authenticationType: pulumi.Input<string>;
/**
* Description about the provider.
*/
comment?: pulumi.Input<string>;
/**
* Name of provider. Change forces creation of a new resource.
*/
name?: pulumi.Input<string>;
/**
* This is the json file that is created from a recipient url.
*/
recipientProfileStr: pulumi.Input<string>;
}