Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks
  3. API Docs
  4. MwsPrivateAccessSettings
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.MwsPrivateAccessSettings

Explore with Pulumi AI

databricks logo
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

    Allows you to create a Private Access Setting resource 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.

    Databricks on AWS usage

    Initialize provider with alias = "mws", host = "https://accounts.cloud.databricks.com" and use provider = databricks.mws

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

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

    import pulumi
import pulumi_databricks as databricks

pas = databricks.MwsPrivateAccessSettings("pas",
    account_id=databricks_account_id,
    private_access_settings_name=f"Private Access Settings for {prefix}",
    region=region,
    public_access_enabled=True)

    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(databricksAccountId),
			PrivateAccessSettingsName: pulumi.Sprintf("Private Access Settings for %v", prefix),
			Region:                    pulumi.Any(region),
			PublicAccessEnabled:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 = databricksAccountId,
        PrivateAccessSettingsName = $"Private Access Settings for {prefix}",
        Region = region,
        PublicAccessEnabled = true,
    });

});

    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 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(databricksAccountId)
            .privateAccessSettingsName(String.format("Private Access Settings for %s", prefix))
            .region(region)
            .publicAccessEnabled(true)
            .build());

    }
}

    resources:
  pas:
    type: databricks:MwsPrivateAccessSettings
    properties:
      accountId: ${databricksAccountId}
      privateAccessSettingsName: Private Access Settings for ${prefix}
      region: ${region}
      publicAccessEnabled: true

    The databricks_mws_private_access_settings.pas.private_access_settings_id can then be used as part of a databricks.MwsWorkspaces resource:

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

const _this = new databricks.MwsWorkspaces("this", {
    awsRegion: region,
    workspaceName: prefix,
    credentialsId: thisDatabricksMwsCredentials.credentialsId,
    storageConfigurationId: thisDatabricksMwsStorageConfigurations.storageConfigurationId,
    networkId: thisDatabricksMwsNetworks.networkId,
    privateAccessSettingsId: pas.privateAccessSettingsId,
    pricingTier: "ENTERPRISE",
}, {
    dependsOn: [thisDatabricksMwsNetworks],
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.MwsWorkspaces("this",
    aws_region=region,
    workspace_name=prefix,
    credentials_id=this_databricks_mws_credentials["credentialsId"],
    storage_configuration_id=this_databricks_mws_storage_configurations["storageConfigurationId"],
    network_id=this_databricks_mws_networks["networkId"],
    private_access_settings_id=pas["privateAccessSettingsId"],
    pricing_tier="ENTERPRISE",
    opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))

    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{
			AwsRegion:               pulumi.Any(region),
			WorkspaceName:           pulumi.Any(prefix),
			CredentialsId:           pulumi.Any(thisDatabricksMwsCredentials.CredentialsId),
			StorageConfigurationId:  pulumi.Any(thisDatabricksMwsStorageConfigurations.StorageConfigurationId),
			NetworkId:               pulumi.Any(thisDatabricksMwsNetworks.NetworkId),
			PrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),
			PricingTier:             pulumi.String("ENTERPRISE"),
		}, pulumi.DependsOn([]pulumi.Resource{
			thisDatabricksMwsNetworks,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.MwsWorkspaces("this", new()
    {
        AwsRegion = region,
        WorkspaceName = prefix,
        CredentialsId = thisDatabricksMwsCredentials.CredentialsId,
        StorageConfigurationId = thisDatabricksMwsStorageConfigurations.StorageConfigurationId,
        NetworkId = thisDatabricksMwsNetworks.NetworkId,
        PrivateAccessSettingsId = pas.PrivateAccessSettingsId,
        PricingTier = "ENTERPRISE",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            thisDatabricksMwsNetworks,
        },
    });

});

    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()
            .awsRegion(region)
            .workspaceName(prefix)
            .credentialsId(thisDatabricksMwsCredentials.credentialsId())
            .storageConfigurationId(thisDatabricksMwsStorageConfigurations.storageConfigurationId())
            .networkId(thisDatabricksMwsNetworks.networkId())
            .privateAccessSettingsId(pas.privateAccessSettingsId())
            .pricingTier("ENTERPRISE")
            .build(), CustomResourceOptions.builder()
                .dependsOn(thisDatabricksMwsNetworks)
                .build());

    }
}

    resources:
  this:
    type: databricks:MwsWorkspaces
    properties:
      awsRegion: ${region}
      workspaceName: ${prefix}
      credentialsId: ${thisDatabricksMwsCredentials.credentialsId}
      storageConfigurationId: ${thisDatabricksMwsStorageConfigurations.storageConfigurationId}
      networkId: ${thisDatabricksMwsNetworks.networkId}
      privateAccessSettingsId: ${pas.privateAccessSettingsId}
      pricingTier: ENTERPRISE
    options:
      dependson:
        - ${thisDatabricksMwsNetworks}

    Databricks on GCP usage

    Initialize provider with alias = "mws", host = "https://accounts.gcp.databricks.com" and use provider = databricks.mws

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

const _this = new databricks.MwsWorkspaces("this", {
    workspaceName: "gcp-workspace",
    location: subnetRegion,
    cloudResourceContainer: {
        gcp: {
            projectId: googleProject,
        },
    },
    gkeConfig: {
        connectivityType: "PRIVATE_NODE_PUBLIC_MASTER",
        masterIpRange: "10.3.0.0/28",
    },
    networkId: thisDatabricksMwsNetworks.networkId,
    privateAccessSettingsId: pas.privateAccessSettingsId,
    pricingTier: "PREMIUM",
}, {
    dependsOn: [thisDatabricksMwsNetworks],
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.MwsWorkspaces("this",
    workspace_name="gcp-workspace",
    location=subnet_region,
    cloud_resource_container={
        "gcp": {
            "project_id": google_project,
        },
    },
    gke_config={
        "connectivity_type": "PRIVATE_NODE_PUBLIC_MASTER",
        "master_ip_range": "10.3.0.0/28",
    },
    network_id=this_databricks_mws_networks["networkId"],
    private_access_settings_id=pas["privateAccessSettingsId"],
    pricing_tier="PREMIUM",
    opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))

    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{
			WorkspaceName: pulumi.String("gcp-workspace"),
			Location:      pulumi.Any(subnetRegion),
			CloudResourceContainer: &databricks.MwsWorkspacesCloudResourceContainerArgs{
				Gcp: &databricks.MwsWorkspacesCloudResourceContainerGcpArgs{
					ProjectId: pulumi.Any(googleProject),
				},
			},
			GkeConfig: &databricks.MwsWorkspacesGkeConfigArgs{
				ConnectivityType: pulumi.String("PRIVATE_NODE_PUBLIC_MASTER"),
				MasterIpRange:    pulumi.String("10.3.0.0/28"),
			},
			NetworkId:               pulumi.Any(thisDatabricksMwsNetworks.NetworkId),
			PrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),
			PricingTier:             pulumi.String("PREMIUM"),
		}, pulumi.DependsOn([]pulumi.Resource{
			thisDatabricksMwsNetworks,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.MwsWorkspaces("this", new()
    {
        WorkspaceName = "gcp-workspace",
        Location = subnetRegion,
        CloudResourceContainer = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerArgs
        {
            Gcp = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerGcpArgs
            {
                ProjectId = googleProject,
            },
        },
        GkeConfig = new Databricks.Inputs.MwsWorkspacesGkeConfigArgs
        {
            ConnectivityType = "PRIVATE_NODE_PUBLIC_MASTER",
            MasterIpRange = "10.3.0.0/28",
        },
        NetworkId = thisDatabricksMwsNetworks.NetworkId,
        PrivateAccessSettingsId = pas.PrivateAccessSettingsId,
        PricingTier = "PREMIUM",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            thisDatabricksMwsNetworks,
        },
    });

});

    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()
            .workspaceName("gcp-workspace")
            .location(subnetRegion)
            .cloudResourceContainer(MwsWorkspacesCloudResourceContainerArgs.builder()
                .gcp(MwsWorkspacesCloudResourceContainerGcpArgs.builder()
                    .projectId(googleProject)
                    .build())
                .build())
            .gkeConfig(MwsWorkspacesGkeConfigArgs.builder()
                .connectivityType("PRIVATE_NODE_PUBLIC_MASTER")
                .masterIpRange("10.3.0.0/28")
                .build())
            .networkId(thisDatabricksMwsNetworks.networkId())
            .privateAccessSettingsId(pas.privateAccessSettingsId())
            .pricingTier("PREMIUM")
            .build(), CustomResourceOptions.builder()
                .dependsOn(thisDatabricksMwsNetworks)
                .build());

    }
}

    resources:
  this:
    type: databricks:MwsWorkspaces
    properties:
      workspaceName: gcp-workspace
      location: ${subnetRegion}
      cloudResourceContainer:
        gcp:
          projectId: ${googleProject}
      gkeConfig:
        connectivityType: PRIVATE_NODE_PUBLIC_MASTER
        masterIpRange: 10.3.0.0/28
      networkId: ${thisDatabricksMwsNetworks.networkId}
      privateAccessSettingsId: ${pas.privateAccessSettingsId}
      pricingTier: PREMIUM
    options:
      dependson:
        - ${thisDatabricksMwsNetworks}

    The following resources are used in the same context:

    • Provisioning Databricks on AWS guide.
    • Provisioning Databricks on AWS with Private Link guide.
    • Provisioning AWS Databricks workspaces with a Hub & Spoke firewall for data exfiltration protection guide.
    • Provisioning Databricks workspaces on GCP with Private Service Connect guide.
    • databricks.MwsVpcEndpoint to register aws_vpc_endpoint 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 AWS and GCP workspaces.

    Create MwsPrivateAccessSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MwsPrivateAccessSettings(name: string, args: MwsPrivateAccessSettingsArgs, opts?: CustomResourceOptions);
    @overload
def MwsPrivateAccessSettings(resource_name: str,
                             args: MwsPrivateAccessSettingsArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def MwsPrivateAccessSettings(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             private_access_settings_name: Optional[str] = None,
                             region: Optional[str] = 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,
                             public_access_enabled: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var mwsPrivateAccessSettingsResource = new Databricks.MwsPrivateAccessSettings("mwsPrivateAccessSettingsResource", new()
{
    PrivateAccessSettingsName = "string",
    Region = "string",
    AllowedVpcEndpointIds = new[]
    {
        "string",
    },
    PrivateAccessLevel = "string",
    PrivateAccessSettingsId = "string",
    PublicAccessEnabled = false,
});

    example, err := databricks.NewMwsPrivateAccessSettings(ctx, "mwsPrivateAccessSettingsResource", &databricks.MwsPrivateAccessSettingsArgs{
	PrivateAccessSettingsName: pulumi.String("string"),
	Region:                    pulumi.String("string"),
	AllowedVpcEndpointIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateAccessLevel:      pulumi.String("string"),
	PrivateAccessSettingsId: pulumi.String("string"),
	PublicAccessEnabled:     pulumi.Bool(false),
})

    var mwsPrivateAccessSettingsResource = new MwsPrivateAccessSettings("mwsPrivateAccessSettingsResource", MwsPrivateAccessSettingsArgs.builder()
    .privateAccessSettingsName("string")
    .region("string")
    .allowedVpcEndpointIds("string")
    .privateAccessLevel("string")
    .privateAccessSettingsId("string")
    .publicAccessEnabled(false)
    .build());

    mws_private_access_settings_resource = databricks.MwsPrivateAccessSettings("mwsPrivateAccessSettingsResource",
    private_access_settings_name="string",
    region="string",
    allowed_vpc_endpoint_ids=["string"],
    private_access_level="string",
    private_access_settings_id="string",
    public_access_enabled=False)

    const mwsPrivateAccessSettingsResource = new databricks.MwsPrivateAccessSettings("mwsPrivateAccessSettingsResource", {
    privateAccessSettingsName: "string",
    region: "string",
    allowedVpcEndpointIds: ["string"],
    privateAccessLevel: "string",
    privateAccessSettingsId: "string",
    publicAccessEnabled: false,
});

    type: databricks:MwsPrivateAccessSettings
properties:
    allowedVpcEndpointIds:
        - string
    privateAccessLevel: string
    privateAccessSettingsId: string
    privateAccessSettingsName: string
    publicAccessEnabled: false
    region: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    PrivateAccessSettingsName string
    Name of Private Access Settings in Databricks Account
    Region string
    Region of AWS VPC or the Google Cloud VPC network
    AccountId string

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    privateAccessSettingsName String
    Name of Private Access Settings in Databricks Account
    region String
    Region of AWS VPC or the Google Cloud VPC network
    accountId String

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    privateAccessSettingsName string
    Name of Private Access Settings in Databricks Account
    region string
    Region of AWS VPC or the Google Cloud VPC network
    accountId string

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    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

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    privateAccessSettingsName String
    Name of Private Access Settings in Databricks Account
    region String
    Region of AWS VPC or the Google Cloud VPC network
    accountId String

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.

    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) -> 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

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    Region string
    Region of AWS VPC or the Google Cloud VPC network
    AccountId string

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    Region string
    Region of AWS VPC or the Google Cloud VPC network
    accountId String

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    region String
    Region of AWS VPC or the Google Cloud VPC network
    accountId string

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    region string
    Region of AWS VPC or the Google Cloud VPC network
    account_id str

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    region str
    Region of AWS VPC or the Google Cloud VPC network
    accountId String

    Deprecated: Configuring account_id at the resource-level is deprecated; please specify it in the provider {} configuration block instead

    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. Once explicitly set, this field becomes mandatory.
    region String
    Region of AWS VPC or the Google Cloud VPC network

    Import

    !> Importing this resource is not currently supported.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-databricks