@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
96 lines (95 loc) • 4.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > Initialize provider with `alias = "account"`, `host = "https://accounts.azuredatabricks.net"` and use `provider = databricks.account` for all `databricks_mws_*` resources.
*
* > This feature is available for AWS & Azure only, and is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html) in AWS.
*
* Allows you to attach a Network Connectivity Config object to a databricks.MwsWorkspaces resource to create a [Databricks Workspace that leverages serverless network connectivity configs](https://learn.microsoft.com/en-us/azure/databricks/sql/admin/serverless-firewall).
*
* The NCC and workspace must be in the same region.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const config = new pulumi.Config();
* const region = config.requireObject("region");
* const prefix = config.requireObject("prefix");
* const ncc = new databricks.MwsNetworkConnectivityConfig("ncc", {
* name: `ncc-for-${prefix}`,
* region: region,
* });
* const nccBinding = new databricks.MwsNccBinding("ncc_binding", {
* networkConnectivityConfigId: ncc.networkConnectivityConfigId,
* workspaceId: databricksWorkspaceId,
* });
* ```
*
* ## Related Resources
*
* The following resources are used in the context:
*
* * databricks.MwsWorkspaces to set up Databricks workspaces.
* * databricks.MwsNetworkConnectivityConfig to create Network Connectivity Config objects.
*/
export declare class MwsNccBinding extends pulumi.CustomResource {
/**
* Get an existing MwsNccBinding 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?: MwsNccBindingState, opts?: pulumi.CustomResourceOptions): MwsNccBinding;
/**
* Returns true if the given object is an instance of MwsNccBinding. 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 MwsNccBinding;
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account.
*/
readonly networkConnectivityConfigId: pulumi.Output<string>;
/**
* Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.
*/
readonly workspaceId: pulumi.Output<string>;
/**
* Create a MwsNccBinding 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: MwsNccBindingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MwsNccBinding resources.
*/
export interface MwsNccBindingState {
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account.
*/
networkConnectivityConfigId?: pulumi.Input<string>;
/**
* Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.
*/
workspaceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MwsNccBinding resource.
*/
export interface MwsNccBindingArgs {
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account.
*/
networkConnectivityConfigId: pulumi.Input<string>;
/**
* Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.
*/
workspaceId: pulumi.Input<string>;
}