com.databricks.sdk.service.provisioning.PrivateAccessService Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.provisioning;
import com.databricks.sdk.support.Generated;
import java.util.Collection;
/**
* These APIs manage private access settings for this account.
*
* This is the high-level interface, that contains generated methods.
*
*
Evolving: this interface is under development. Method signatures may change.
*/
@Generated
public interface PrivateAccessService {
/**
* 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
*/
PrivateAccessSettings create(
UpsertPrivateAccessSettingsRequest upsertPrivateAccessSettingsRequest);
/**
* 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
*/
void delete(DeletePrivateAccesRequest deletePrivateAccesRequest);
/**
* 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
*/
PrivateAccessSettings get(GetPrivateAccesRequest getPrivateAccesRequest);
/**
* Get all private access settings objects.
*
*
Gets a list of all private access settings objects for an account, specified by ID.
*/
Collection list();
/**
* 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
*/
void replace(UpsertPrivateAccessSettingsRequest upsertPrivateAccessSettingsRequest);
}