databricks.MwsPrivateAccessSettings (v0)

Databricks v0.4.0 (0.x), Mar 9 26

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

Import

-> Note Importing this resource is not currently supported.

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,
                             status: Optional[str] = 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",
    AccountId = "string",
    AllowedVpcEndpointIds = new[]
    {
        "string",
    },
    PrivateAccessLevel = "string",
    PrivateAccessSettingsId = "string",
    PublicAccessEnabled = false,
    Status = "string",
});

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

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

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

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

type: databricks:MwsPrivateAccessSettings
properties:
    accountId: string
    allowedVpcEndpointIds:
        - string
    privateAccessLevel: string
    privateAccessSettingsId: string
    privateAccessSettingsName: string
    publicAccessEnabled: false
    region: string
    status: 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

AccountId string

Account Id that could be found in the bottom left corner of Accounts Console

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. ANY level access (default) lets any databricks.MwsVpcEndpoint connect to your databricks_mws_workspaces. ACCOUNT level access 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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

Status string

Status of Private Access Settings

PrivateAccessSettingsName string

Name of Private Access Settings in Databricks Account

Region string

Region of AWS VPC

AccountId string

Account Id that could be found in the bottom left corner of Accounts Console

AllowedVpcEndpointIds []string

PrivateAccessLevel string

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

Status string

Status of Private Access Settings

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

region String

Region of AWS VPC

accountId String

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds List<String>

privateAccessLevel String

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

status String

Status of Private Access Settings

privateAccessSettingsName string

Name of Private Access Settings in Databricks Account

region string

Region of AWS VPC

accountId string

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds string[]

privateAccessLevel string

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

status string

Status of Private Access Settings

private_access_settings_name str

Name of Private Access Settings in Databricks Account

region str

Region of AWS VPC

account_id str

Account Id that could be found in the bottom left corner of Accounts Console

allowed_vpc_endpoint_ids Sequence[str]

private_access_level str

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

status str

Status of Private Access Settings

privateAccessSettingsName String

Name of Private Access Settings in Databricks Account

region String

Region of AWS VPC

accountId String

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds List<String>

privateAccessLevel String

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

status String

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)

resources:  _:    type: databricks:MwsPrivateAccessSettings    get:      id: ${id}

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 bottom left corner of Accounts Console

AllowedVpcEndpointIds List<string>

PrivateAccessLevel string

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

Region string

Region of AWS VPC

Status string

Status of Private Access Settings

AccountId string

Account Id that could be found in the bottom left corner of Accounts Console

AllowedVpcEndpointIds []string

PrivateAccessLevel string

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

Region string

Region of AWS VPC

Status string

Status of Private Access Settings

accountId String

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds List<String>

privateAccessLevel String

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

region String

Region of AWS VPC

status String

Status of Private Access Settings

accountId string

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds string[]

privateAccessLevel string

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

region string

Region of AWS VPC

status string

Status of Private Access Settings

account_id str

Account Id that could be found in the bottom left corner of Accounts Console

allowed_vpc_endpoint_ids Sequence[str]

private_access_level str

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

region str

Region of AWS VPC

status str

Status of Private Access Settings

accountId String

Account Id that could be found in the bottom left corner of Accounts Console

allowedVpcEndpointIds List<String>

privateAccessLevel String

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 (default), the workspace can be accessed only over VPC endpoints, and not over the public network.

region String

Region of AWS VPC

status String

Status of Private Access Settings

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

databricks.MwsPrivateAccessSettings

On this page

On this page

Import

Create MwsPrivateAccessSettings Resource

Constructor syntax

Parameters

Constructor example

MwsPrivateAccessSettings Resource Properties

Inputs

Outputs

Look up Existing MwsPrivateAccessSettings Resource

Package Details

On this page

On this page