@pulumi/databricks/workspaceNetworkOption.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * [![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * Workspace network options allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace.
 *
 * Each workspace is always associated with exactly one network policy that controls which network destinations can be accessed from the Databricks environment. By default, workspaces are associated with the `default-policy` network policy.
 *
 * This resource has the following characteristics:
 *
 * - You cannot create or delete a workspace's network option
 * - You can only update it to associate the workspace with a different policy
 * - This resource is used to change the network policy assignment for existing workspaces
 *
 * > **Note** This resource can only be used with an account-level provider!
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const exampleWorkspaceNetworkOption = new databricks.WorkspaceNetworkOption("example_workspace_network_option", {
 *     workspaceId: "9999999999999999",
 *     networkPolicyId: "default-policy",
 * });
 * ```
 *
 * ## Import
 *
 * As of Pulumi v1.5, resources can be imported through configuration.
 *
 * hcl
 *
 * import {
 *
 *   id = "workspace_id"
 *
 *   to = databricks_workspace_network_option.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/workspaceNetworkOption:WorkspaceNetworkOption this "workspace_id"
 * ```
 */
export declare class WorkspaceNetworkOption extends pulumi.CustomResource {
    /**
     * Get an existing WorkspaceNetworkOption 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?: WorkspaceNetworkOptionState, opts?: pulumi.CustomResourceOptions): WorkspaceNetworkOption;
    /**
     * Returns true if the given object is an instance of WorkspaceNetworkOption.  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 WorkspaceNetworkOption;
    /**
     * The network policy ID to apply to the workspace. This controls the network access rules
     * for all serverless compute resources in the workspace. Each workspace can only be
     * linked to one policy at a time. If no policy is explicitly assigned,
     * the workspace will use 'default-policy'
     */
    readonly networkPolicyId: pulumi.Output<string | undefined>;
    /**
     * The workspace ID
     */
    readonly workspaceId: pulumi.Output<string | undefined>;
    /**
     * Create a WorkspaceNetworkOption 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?: WorkspaceNetworkOptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering WorkspaceNetworkOption resources.
 */
export interface WorkspaceNetworkOptionState {
    /**
     * The network policy ID to apply to the workspace. This controls the network access rules
     * for all serverless compute resources in the workspace. Each workspace can only be
     * linked to one policy at a time. If no policy is explicitly assigned,
     * the workspace will use 'default-policy'
     */
    networkPolicyId?: pulumi.Input<string>;
    /**
     * The workspace ID
     */
    workspaceId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a WorkspaceNetworkOption resource.
 */
export interface WorkspaceNetworkOptionArgs {
    /**
     * The network policy ID to apply to the workspace. This controls the network access rules
     * for all serverless compute resources in the workspace. Each workspace can only be
     * linked to one policy at a time. If no policy is explicitly assigned,
     * the workspace will use 'default-policy'
     */
    networkPolicyId?: pulumi.Input<string>;
    /**
     * The workspace ID
     */
    workspaceId?: pulumi.Input<string>;
}