Package com.databricks.sdk.service.provisioning

Class PrivateAccessAPI

java.lang.Object

com.databricks.sdk.service.provisioning.PrivateAccessAPI

@Generated
public class PrivateAccessAPI
extends Object

These APIs manage private access settings for this account.

Constructor Summary

Constructors

Constructor	Description
PrivateAccessAPI(ApiClient apiClient)	Regular-use constructor
PrivateAccessAPI(PrivateAccessService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
PrivateAccessSettings	create(UpsertPrivateAccessSettingsRequest request)	Create private access settings.
PrivateAccessSettings	create(String privateAccessSettingsName, String region, String privateAccessSettingsId)
void	delete(DeletePrivateAccesRequest request)	Delete a private access settings object.
void	delete(String privateAccessSettingsId)
PrivateAccessSettings	get(GetPrivateAccesRequest request)	Get a private access settings object.
PrivateAccessSettings	get(String privateAccessSettingsId)
PrivateAccessService	impl()
Iterable<PrivateAccessSettings>	list()	Get all private access settings objects.
void	replace(UpsertPrivateAccessSettingsRequest request)	Replace private access settings.
void	replace(String privateAccessSettingsName, String region, String privateAccessSettingsId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrivateAccessAPI

public PrivateAccessAPI(ApiClient apiClient)

Regular-use constructor

PrivateAccessAPI

public PrivateAccessAPI(PrivateAccessService mock)

Constructor for mocks

Method Detail

create

public PrivateAccessSettings create(String privateAccessSettingsName,
                                    String region,
                                    String privateAccessSettingsId)

create

public PrivateAccessSettings create(UpsertPrivateAccessSettingsRequest request)

Create private access settings.

Creates a private access settings object, which specifies how your workspace is accessed over [AWS PrivateLink]. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's `private_access_settings_id` property.

You can share one private access settings with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

delete

public void delete(String privateAccessSettingsId)

delete

public void delete(DeletePrivateAccesRequest request)

Delete a private access settings object.

Deletes a private access settings object, which determines how your workspace is accessed over [AWS PrivateLink].

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

get

public PrivateAccessSettings get(String privateAccessSettingsId)

get

public PrivateAccessSettings get(GetPrivateAccesRequest request)

Get a private access settings object.

Gets a private access settings object, which specifies how your workspace is accessed over [AWS PrivateLink].

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

list

public Iterable<PrivateAccessSettings> list()

Get all private access settings objects.

Gets a list of all private access settings objects for an account, specified by ID.

replace

public void replace(String privateAccessSettingsName,
                    String region,
                    String privateAccessSettingsId)

replace

public void replace(UpsertPrivateAccessSettingsRequest request)

Replace private access settings.

Updates an existing private access settings object, which specifies how your workspace is accessed over [AWS PrivateLink]. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's `private_access_settings_id` property.

This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change. If `public_access_enabled`, `private_access_level`, or `allowed_vpc_endpoint_ids` are updated, effects of these changes might take several minutes to propagate to the workspace API.

You can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

impl

public PrivateAccessService impl()