Docs Packages
  1. Pulumi Registry
  2. Databricks
  3. API Docs
  4. MwsPrivateAccessSettings
databricks logo
Databricks v1.14.0, May 23 23

databricks.MwsPrivateAccessSettings

Explore with Pulumi AI

Note Initialize provider with alias = "mws", host = "https://accounts.cloud.databricks.com" and use provider = databricks.mws for all databricks_mws_* resources.

Note This resource has an evolving API, which will change in the upcoming versions of the provider in order to simplify user experience.

Allows you to create a [Private Access Setting]that can be used as part of a databricks.MwsWorkspaces resource to create a Databricks Workspace that leverages AWS PrivateLink or GCP Private Service Connect

It is strongly recommended that customers read the Enable AWS Private Link Enable GCP Private Service Connect documentation before trying to leverage this resource.

The following resources are used in the same context:

  • Provisioning Databricks on AWS guide.
  • Provisioning Databricks on AWS with PrivateLink guide.
  • Provisioning AWS Databricks E2 with a Hub & Spoke firewall for data exfiltration protection guide.
  • Provisioning Databricks workspaces on GCP with Private Service Connect guide.
  • databricks.MwsVpcEndpoint resources with Databricks such that they can be used as part of a databricks.MwsNetworks configuration.
  • databricks.MwsNetworks to configure VPC & subnets for new workspaces within AWS.
  • databricks.MwsWorkspaces to set up workspaces in E2 architecture on AWS.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var pas = new Databricks.MwsPrivateAccessSettings("pas", new()
    {
        AccountId = @var.Databricks_account_id,
        PrivateAccessSettingsName = $"Private Access Settings for {local.Prefix}",
        Region = @var.Region,
        PublicAccessEnabled = true,
    }, new CustomResourceOptions
    {
        Provider = databricks.Mws,
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewMwsPrivateAccessSettings(ctx, "pas", &databricks.MwsPrivateAccessSettingsArgs{
			AccountId:                 pulumi.Any(_var.Databricks_account_id),
			PrivateAccessSettingsName: pulumi.String(fmt.Sprintf("Private Access Settings for %v", local.Prefix)),
			Region:                    pulumi.Any(_var.Region),
			PublicAccessEnabled:       pulumi.Bool(true),
		}, pulumi.Provider(databricks.Mws))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.MwsPrivateAccessSettings;
import com.pulumi.databricks.MwsPrivateAccessSettingsArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pas = new MwsPrivateAccessSettings("pas", MwsPrivateAccessSettingsArgs.builder()        
            .accountId(var_.databricks_account_id())
            .privateAccessSettingsName(String.format("Private Access Settings for %s", local.prefix()))
            .region(var_.region())
            .publicAccessEnabled(true)
            .build(), CustomResourceOptions.builder()
                .provider(databricks.mws())
                .build());

    }
}

import pulumi
import pulumi_databricks as databricks

pas = databricks.MwsPrivateAccessSettings("pas",
    account_id=var["databricks_account_id"],
    private_access_settings_name=f"Private Access Settings for {local['prefix']}",
    region=var["region"],
    public_access_enabled=True,
    opts=pulumi.ResourceOptions(provider=databricks["mws"]))

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const pas = new databricks.MwsPrivateAccessSettings("pas", {
    accountId: _var.databricks_account_id,
    privateAccessSettingsName: `Private Access Settings for ${local.prefix}`,
    region: _var.region,
    publicAccessEnabled: true,
}, {
    provider: databricks.mws,
});

resources:
  pas:
    type: databricks:MwsPrivateAccessSettings
    properties:
      accountId: ${var.databricks_account_id}
      privateAccessSettingsName: Private Access Settings for ${local.prefix}
      region: ${var.region}
      publicAccessEnabled: true
    options:
      provider: ${databricks.mws}

can then be used as part of a databricks.MwsWorkspaces resource

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.MwsWorkspaces("this", new()
    {
        AccountId = @var.Databricks_account_id,
        AwsRegion = @var.Region,
        WorkspaceName = local.Prefix,
        CredentialsId = databricks_mws_credentials.This.Credentials_id,
        StorageConfigurationId = databricks_mws_storage_configurations.This.Storage_configuration_id,
        NetworkId = databricks_mws_networks.This.Network_id,
        PrivateAccessSettingsId = databricks_mws_private_access_settings.Pas.Private_access_settings_id,
        PricingTier = "ENTERPRISE",
    }, new CustomResourceOptions
    {
        Provider = databricks.Mws,
        DependsOn = new[]
        {
            databricks_mws_networks.This,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewMwsWorkspaces(ctx, "this", &databricks.MwsWorkspacesArgs{
			AccountId:               pulumi.Any(_var.Databricks_account_id),
			AwsRegion:               pulumi.Any(_var.Region),
			WorkspaceName:           pulumi.Any(local.Prefix),
			CredentialsId:           pulumi.Any(databricks_mws_credentials.This.Credentials_id),
			StorageConfigurationId:  pulumi.Any(databricks_mws_storage_configurations.This.Storage_configuration_id),
			NetworkId:               pulumi.Any(databricks_mws_networks.This.Network_id),
			PrivateAccessSettingsId: pulumi.Any(databricks_mws_private_access_settings.Pas.Private_access_settings_id),
			PricingTier:             pulumi.String("ENTERPRISE"),
		}, pulumi.Provider(databricks.Mws), pulumi.DependsOn([]pulumi.Resource{
			databricks_mws_networks.This,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.MwsWorkspaces;
import com.pulumi.databricks.MwsWorkspacesArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new MwsWorkspaces("this", MwsWorkspacesArgs.builder()        
            .accountId(var_.databricks_account_id())
            .awsRegion(var_.region())
            .workspaceName(local.prefix())
            .credentialsId(databricks_mws_credentials.this().credentials_id())
            .storageConfigurationId(databricks_mws_storage_configurations.this().storage_configuration_id())
            .networkId(databricks_mws_networks.this().network_id())
            .privateAccessSettingsId(databricks_mws_private_access_settings.pas().private_access_settings_id())
            .pricingTier("ENTERPRISE")
            .build(), CustomResourceOptions.builder()
                .provider(databricks.mws())
                .dependsOn(databricks_mws_networks.this())
                .build());

    }
}

import pulumi
import pulumi_databricks as databricks

this = databricks.MwsWorkspaces("this",
    account_id=var["databricks_account_id"],
    aws_region=var["region"],
    workspace_name=local["prefix"],
    credentials_id=databricks_mws_credentials["this"]["credentials_id"],
    storage_configuration_id=databricks_mws_storage_configurations["this"]["storage_configuration_id"],
    network_id=databricks_mws_networks["this"]["network_id"],
    private_access_settings_id=databricks_mws_private_access_settings["pas"]["private_access_settings_id"],
    pricing_tier="ENTERPRISE",
    opts=pulumi.ResourceOptions(provider=databricks["mws"],
        depends_on=[databricks_mws_networks["this"]]))

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = new databricks.MwsWorkspaces("this", {
    accountId: _var.databricks_account_id,
    awsRegion: _var.region,
    workspaceName: local.prefix,
    credentialsId: databricks_mws_credentials["this"].credentials_id,
    storageConfigurationId: databricks_mws_storage_configurations["this"].storage_configuration_id,
    networkId: databricks_mws_networks["this"].network_id,
    privateAccessSettingsId: databricks_mws_private_access_settings.pas.private_access_settings_id,
    pricingTier: "ENTERPRISE",
}, {
    provider: databricks.mws,
    dependsOn: [databricks_mws_networks["this"]],
});

resources:
  this:
    type: databricks:MwsWorkspaces
    properties:
      accountId: ${var.databricks_account_id}
      awsRegion: ${var.region}
      workspaceName: ${local.prefix}
      credentialsId: ${databricks_mws_credentials.this.credentials_id}
      storageConfigurationId: ${databricks_mws_storage_configurations.this.storage_configuration_id}
      networkId: ${databricks_mws_networks.this.network_id}
      privateAccessSettingsId: ${databricks_mws_private_access_settings.pas.private_access_settings_id}
      pricingTier: ENTERPRISE
    options:
      provider: ${databricks.mws}
      dependson:
        - ${databricks_mws_networks.this}

or

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.MwsWorkspaces("this", new()
    {
        AccountId = @var.Databricks_account_id,
        WorkspaceName = "gcp-workspace",
        Location = @var.Subnet_region,
        CloudResourceContainer = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerArgs
        {
            Gcp = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerGcpArgs
            {
                ProjectId = @var.Google_project,
            },
        },
        GkeConfig = new Databricks.Inputs.MwsWorkspacesGkeConfigArgs
        {
            ConnectivityType = "PRIVATE_NODE_PUBLIC_MASTER",
            MasterIpRange = "10.3.0.0/28",
        },
        NetworkId = databricks_mws_networks.This.Network_id,
        PrivateAccessSettingsId = databricks_mws_private_access_settings.Pas.Private_access_settings_id,
        PricingTier = "PREMIUM",
    }, new CustomResourceOptions
    {
        Provider = databricks.Mws,
        DependsOn = new[]
        {
            databricks_mws_networks.This,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewMwsWorkspaces(ctx, "this", &databricks.MwsWorkspacesArgs{
			AccountId:     pulumi.Any(_var.Databricks_account_id),
			WorkspaceName: pulumi.String("gcp-workspace"),
			Location:      pulumi.Any(_var.Subnet_region),
			CloudResourceContainer: &databricks.MwsWorkspacesCloudResourceContainerArgs{
				Gcp: &databricks.MwsWorkspacesCloudResourceContainerGcpArgs{
					ProjectId: pulumi.Any(_var.Google_project),
				},
			},
			GkeConfig: &databricks.MwsWorkspacesGkeConfigArgs{
				ConnectivityType: pulumi.String("PRIVATE_NODE_PUBLIC_MASTER"),
				MasterIpRange:    pulumi.String("10.3.0.0/28"),
			},
			NetworkId:               pulumi.Any(databricks_mws_networks.This.Network_id),
			PrivateAccessSettingsId: pulumi.Any(databricks_mws_private_access_settings.Pas.Private_access_settings_id),
			PricingTier:             pulumi.String("PREMIUM"),
		}, pulumi.Provider(databricks.Mws), pulumi.DependsOn([]pulumi.Resource{
			databricks_mws_networks.This,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.MwsWorkspaces;
import com.pulumi.databricks.MwsWorkspacesArgs;
import com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerArgs;
import com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerGcpArgs;
import com.pulumi.databricks.inputs.MwsWorkspacesGkeConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new MwsWorkspaces("this", MwsWorkspacesArgs.builder()        
            .accountId(var_.databricks_account_id())
            .workspaceName("gcp-workspace")
            .location(var_.subnet_region())
            .cloudResourceContainer(MwsWorkspacesCloudResourceContainerArgs.builder()
                .gcp(MwsWorkspacesCloudResourceContainerGcpArgs.builder()
                    .projectId(var_.google_project())
                    .build())
                .build())
            .gkeConfig(MwsWorkspacesGkeConfigArgs.builder()
                .connectivityType("PRIVATE_NODE_PUBLIC_MASTER")
                .masterIpRange("10.3.0.0/28")
                .build())
            .networkId(databricks_mws_networks.this().network_id())
            .privateAccessSettingsId(databricks_mws_private_access_settings.pas().private_access_settings_id())
            .pricingTier("PREMIUM")
            .build(), CustomResourceOptions.builder()
                .provider(databricks.mws())
                .dependsOn(databricks_mws_networks.this())
                .build());

    }
}

import pulumi
import pulumi_databricks as databricks

this = databricks.MwsWorkspaces("this",
    account_id=var["databricks_account_id"],
    workspace_name="gcp-workspace",
    location=var["subnet_region"],
    cloud_resource_container=databricks.MwsWorkspacesCloudResourceContainerArgs(
        gcp=databricks.MwsWorkspacesCloudResourceContainerGcpArgs(
            project_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
        ),
    ),
    gke_config=databricks.MwsWorkspacesGkeConfigArgs(
        connectivity_type="PRIVATE_NODE_PUBLIC_MASTER",
        master_ip_range="10.3.0.0/28",
    ),
    network_id=databricks_mws_networks["this"]["network_id"],
    private_access_settings_id=databricks_mws_private_access_settings["pas"]["private_access_settings_id"],
    pricing_tier="PREMIUM",
    opts=pulumi.ResourceOptions(provider=databricks["mws"],
        depends_on=[databricks_mws_networks["this"]]))

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = new databricks.MwsWorkspaces("this", {
    accountId: _var.databricks_account_id,
    workspaceName: "gcp-workspace",
    location: _var.subnet_region,
    cloudResourceContainer: {
        gcp: {
            projectId: _var.google_project,
        },
    },
    gkeConfig: {
        connectivityType: "PRIVATE_NODE_PUBLIC_MASTER",
        masterIpRange: "10.3.0.0/28",
    },
    networkId: databricks_mws_networks["this"].network_id,
    privateAccessSettingsId: databricks_mws_private_access_settings.pas.private_access_settings_id,
    pricingTier: "PREMIUM",
}, {
    provider: databricks.mws,
    dependsOn: [databricks_mws_networks["this"]],
});

resources:
  this:
    type: databricks:MwsWorkspaces
    properties:
      accountId: ${var.databricks_account_id}
      workspaceName: gcp-workspace
      location: ${var.subnet_region}
      cloudResourceContainer:
        gcp:
          projectId: ${var.google_project}
      gkeConfig:
        connectivityType: PRIVATE_NODE_PUBLIC_MASTER
        masterIpRange: 10.3.0.0/28
      networkId: ${databricks_mws_networks.this.network_id}
      privateAccessSettingsId: ${databricks_mws_private_access_settings.pas.private_access_settings_id}
      pricingTier: PREMIUM
    options:
      provider: ${databricks.mws}
      dependson:
        - ${databricks_mws_networks.this}

Create MwsPrivateAccessSettings Resource

new MwsPrivateAccessSettings(name: string, args: MwsPrivateAccessSettingsArgs, opts?: CustomResourceOptions);
@overload
def MwsPrivateAccessSettings(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             account_id: Optional[str] = None,
                             allowed_vpc_endpoint_ids: Optional[Sequence[str]] = None,
                             private_access_level: Optional[str] = None,
                             private_access_settings_id: Optional[str] = None,
                             private_access_settings_name: Optional[str] = None,
                             public_access_enabled: Optional[bool] = None,
                             region: Optional[str] = None,
                             status: Optional[str] = None)
@overload
def MwsPrivateAccessSettings(resource_name: str,
                             args: MwsPrivateAccessSettingsArgs,
                             opts: Optional[ResourceOptions] = None)
func NewMwsPrivateAccessSettings(ctx *Context, name string, args MwsPrivateAccessSettingsArgs, opts ...ResourceOption) (*MwsPrivateAccessSettings, error)
public MwsPrivateAccessSettings(string name, MwsPrivateAccessSettingsArgs args, CustomResourceOptions? opts = null)
public MwsPrivateAccessSettings(String name, MwsPrivateAccessSettingsArgs args)
public MwsPrivateAccessSettings(String name, MwsPrivateAccessSettingsArgs args, CustomResourceOptions options)

type: databricks:MwsPrivateAccessSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MwsPrivateAccessSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args MwsPrivateAccessSettingsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MwsPrivateAccessSettingsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MwsPrivateAccessSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MwsPrivateAccessSettingsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

MwsPrivateAccessSettings Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MwsPrivateAccessSettings resource accepts the following input properties:

PrivateAccessSettingsName string

Name of Private Access Settings in Databricks Account

Region string

Region of AWS VPC or the Google Cloud VPC network

AccountId string

Account Id that could be found in the Accounts Console for AWS or GCP

AllowedVpcEndpointIds List<string>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

PrivateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

PrivateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

PublicAccessEnabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

Status string

(AWS only) Status of Private Access Settings

PrivateAccessSettingsName string

Name of Private Access Settings in Databricks Account

Region string

Region of AWS VPC or the Google Cloud VPC network

AccountId string

Account Id that could be found in the Accounts Console for AWS or GCP

AllowedVpcEndpointIds []string

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

PrivateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

PrivateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

PublicAccessEnabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

Status string

(AWS only) Status of Private Access Settings

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

region String

Region of AWS VPC or the Google Cloud VPC network

accountId String

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds List<String>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel String

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId String

Canonical unique identifier of Private Access Settings in Databricks Account

publicAccessEnabled Boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

status String

(AWS only) Status of Private Access Settings

privateAccessSettingsName string

Name of Private Access Settings in Databricks Account

region string

Region of AWS VPC or the Google Cloud VPC network

accountId string

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds string[]

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

publicAccessEnabled boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

status string

(AWS only) Status of Private Access Settings

private_access_settings_name str

Name of Private Access Settings in Databricks Account

region str

Region of AWS VPC or the Google Cloud VPC network

account_id str

Account Id that could be found in the Accounts Console for AWS or GCP

allowed_vpc_endpoint_ids Sequence[str]

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

private_access_level str

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

private_access_settings_id str

Canonical unique identifier of Private Access Settings in Databricks Account

public_access_enabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

status str

(AWS only) Status of Private Access Settings

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

region String

Region of AWS VPC or the Google Cloud VPC network

accountId String

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds List<String>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel String

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId String

Canonical unique identifier of Private Access Settings in Databricks Account

publicAccessEnabled Boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

status String

(AWS only) Status of Private Access Settings

Outputs

All input properties are implicitly available as output properties. Additionally, the MwsPrivateAccessSettings resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing MwsPrivateAccessSettings Resource

Get an existing MwsPrivateAccessSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MwsPrivateAccessSettingsState, opts?: CustomResourceOptions): MwsPrivateAccessSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allowed_vpc_endpoint_ids: Optional[Sequence[str]] = None,
        private_access_level: Optional[str] = None,
        private_access_settings_id: Optional[str] = None,
        private_access_settings_name: Optional[str] = None,
        public_access_enabled: Optional[bool] = None,
        region: Optional[str] = None,
        status: Optional[str] = None) -> MwsPrivateAccessSettings
func GetMwsPrivateAccessSettings(ctx *Context, name string, id IDInput, state *MwsPrivateAccessSettingsState, opts ...ResourceOption) (*MwsPrivateAccessSettings, error)
public static MwsPrivateAccessSettings Get(string name, Input<string> id, MwsPrivateAccessSettingsState? state, CustomResourceOptions? opts = null)
public static MwsPrivateAccessSettings get(String name, Output<String> id, MwsPrivateAccessSettingsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string

Account Id that could be found in the Accounts Console for AWS or GCP

AllowedVpcEndpointIds List<string>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

PrivateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

PrivateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

PrivateAccessSettingsName string

Name of Private Access Settings in Databricks Account

PublicAccessEnabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

Region string

Region of AWS VPC or the Google Cloud VPC network

Status string

(AWS only) Status of Private Access Settings

AccountId string

Account Id that could be found in the Accounts Console for AWS or GCP

AllowedVpcEndpointIds []string

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

PrivateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

PrivateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

PrivateAccessSettingsName string

Name of Private Access Settings in Databricks Account

PublicAccessEnabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

Region string

Region of AWS VPC or the Google Cloud VPC network

Status string

(AWS only) Status of Private Access Settings

accountId String

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds List<String>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel String

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId String

Canonical unique identifier of Private Access Settings in Databricks Account

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

publicAccessEnabled Boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

region String

Region of AWS VPC or the Google Cloud VPC network

status String

(AWS only) Status of Private Access Settings

accountId string

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds string[]

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel string

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId string

Canonical unique identifier of Private Access Settings in Databricks Account

privateAccessSettingsName string

Name of Private Access Settings in Databricks Account

publicAccessEnabled boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

region string

Region of AWS VPC or the Google Cloud VPC network

status string

(AWS only) Status of Private Access Settings

account_id str

Account Id that could be found in the Accounts Console for AWS or GCP

allowed_vpc_endpoint_ids Sequence[str]

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

private_access_level str

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

private_access_settings_id str

Canonical unique identifier of Private Access Settings in Databricks Account

private_access_settings_name str

Name of Private Access Settings in Databricks Account

public_access_enabled bool

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

region str

Region of AWS VPC or the Google Cloud VPC network

status str

(AWS only) Status of Private Access Settings

accountId String

Account Id that could be found in the Accounts Console for AWS or GCP

allowedVpcEndpointIds List<String>

An array of databricks.MwsVpcEndpoint vpc_endpoint_id (not id). Only used when private_access_level is set to ENDPOINT. This is an allow list of databricks.MwsVpcEndpoint that in your account that can connect to your databricks.MwsWorkspaces over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.

privateAccessLevel String

The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (default) lets only databricks.MwsVpcEndpoint that are registered in your Databricks account connect to your databricks_mws_workspaces. ENDPOINT level access lets only specified databricks.MwsVpcEndpoint connect to your workspace. Please see the allowed_vpc_endpoint_ids documentation for more details.

privateAccessSettingsId String

Canonical unique identifier of Private Access Settings in Databricks Account

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

publicAccessEnabled Boolean

If true, the databricks.MwsWorkspaces can be accessed over the databricks.MwsVpcEndpoint as well as over the public network. In such a case, you could also configure an databricks.IpAccessList for the workspace, to restrict the source networks that could be used to access it over the public network. If false, the workspace can be accessed only over VPC endpoints, and not over the public network.

region String

Region of AWS VPC or the Google Cloud VPC network

status String

(AWS only) Status of Private Access Settings

Import

-> Note Importing this resource is not currently supported.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.