@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
129 lines (128 loc) • 5.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* > Initialize provider with `alias = "account"`, `host = "https://accounts.azuredatabricks.net"` and use `provider = databricks.account` for all `databricks_mws_*` resources.
*
* > **Public Preview** 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 create a Network Connectivity Config that can be used as part of a databricks.MwsWorkspaces resource to create a [Databricks Workspace that leverages serverless network connectivity configs](https://learn.microsoft.com/en-us/azure/databricks/security/network/serverless-network-security/serverless-firewall).
*
* ## 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.MwsNccBinding to attach an NCC to a workspace.
* * databricks.MwsNccPrivateEndpointRule to create a private endpoint rule.
*
* ## Import
*
* This resource can be imported by Databricks account ID and Network Connectivity Config ID.
*
* ```sh
* $ pulumi import databricks:index/mwsNetworkConnectivityConfig:MwsNetworkConnectivityConfig ncc <account_id>/<network_connectivity_config_id>
* ```
*/
export declare class MwsNetworkConnectivityConfig extends pulumi.CustomResource {
/**
* Get an existing MwsNetworkConnectivityConfig 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?: MwsNetworkConnectivityConfigState, opts?: pulumi.CustomResourceOptions): MwsNetworkConnectivityConfig;
/**
* Returns true if the given object is an instance of MwsNetworkConnectivityConfig. 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 MwsNetworkConnectivityConfig;
readonly accountId: pulumi.Output<string>;
readonly creationTime: pulumi.Output<number>;
readonly egressConfig: pulumi.Output<outputs.MwsNetworkConnectivityConfigEgressConfig>;
/**
* Name of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account
*/
readonly networkConnectivityConfigId: pulumi.Output<string>;
/**
* Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.
*/
readonly region: pulumi.Output<string>;
readonly updatedTime: pulumi.Output<number>;
/**
* Create a MwsNetworkConnectivityConfig 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: MwsNetworkConnectivityConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MwsNetworkConnectivityConfig resources.
*/
export interface MwsNetworkConnectivityConfigState {
accountId?: pulumi.Input<string>;
creationTime?: pulumi.Input<number>;
egressConfig?: pulumi.Input<inputs.MwsNetworkConnectivityConfigEgressConfig>;
/**
* Name of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.
*/
name?: pulumi.Input<string>;
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account
*/
networkConnectivityConfigId?: pulumi.Input<string>;
/**
* Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.
*/
region?: pulumi.Input<string>;
updatedTime?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a MwsNetworkConnectivityConfig resource.
*/
export interface MwsNetworkConnectivityConfigArgs {
accountId?: pulumi.Input<string>;
creationTime?: pulumi.Input<number>;
egressConfig?: pulumi.Input<inputs.MwsNetworkConnectivityConfigEgressConfig>;
/**
* Name of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.
*/
name?: pulumi.Input<string>;
/**
* Canonical unique identifier of Network Connectivity Config in Databricks Account
*/
networkConnectivityConfigId?: pulumi.Input<string>;
/**
* Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.
*/
region: pulumi.Input<string>;
updatedTime?: pulumi.Input<number>;
}