Databricks v1.10.0, Mar 15 23

databricks.ExternalLocation

To work with external tables, Unity Catalog introduces two new objects to access and work with external cloud storage:

databricks.StorageCredential represent authentication methods to access cloud storage (e.g. an IAM role for Amazon S3 or a service principal for Azure Storage). Storage credentials are access-controlled to determine which users can use the credential.
databricks.ExternalLocation are objects that combine a cloud storage path with a Storage Credential that can be used to access the location.

Create ExternalLocation Resource

new ExternalLocation(name: string, args: ExternalLocationArgs, opts?: CustomResourceOptions);

@overload
def ExternalLocation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     comment: Optional[str] = None,
                     credential_name: Optional[str] = None,
                     metastore_id: Optional[str] = None,
                     name: Optional[str] = None,
                     owner: Optional[str] = None,
                     skip_validation: Optional[bool] = None,
                     url: Optional[str] = None)
@overload
def ExternalLocation(resource_name: str,
                     args: ExternalLocationArgs,
                     opts: Optional[ResourceOptions] = None)

func NewExternalLocation(ctx *Context, name string, args ExternalLocationArgs, opts ...ResourceOption) (*ExternalLocation, error)

public ExternalLocation(string name, ExternalLocationArgs args, CustomResourceOptions? opts = null)

public ExternalLocation(String name, ExternalLocationArgs args)
public ExternalLocation(String name, ExternalLocationArgs args, CustomResourceOptions options)

type: databricks:ExternalLocation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExternalLocationArgs: 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 ExternalLocationArgs: 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 ExternalLocationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExternalLocationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExternalLocationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ExternalLocation 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 ExternalLocation resource accepts the following input properties:

CredentialName string: Name of the databricks.StorageCredential to use with this External Location.
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
Comment string: User-supplied free-form text.
MetastoreId string
Name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
Owner string: Username/groupname/sp application_id of the external Location owner.
SkipValidation bool: Suppress validation errors if any & force save the external location

CredentialName string: Name of the databricks.StorageCredential to use with this External Location.
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
Comment string: User-supplied free-form text.
MetastoreId string
Name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
Owner string: Username/groupname/sp application_id of the external Location owner.
SkipValidation bool: Suppress validation errors if any & force save the external location

credentialName String: Name of the databricks.StorageCredential to use with this External Location.
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
comment String: User-supplied free-form text.
metastoreId String
name String: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner String: Username/groupname/sp application_id of the external Location owner.
skipValidation Boolean: Suppress validation errors if any & force save the external location

credentialName string: Name of the databricks.StorageCredential to use with this External Location.
url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
comment string: User-supplied free-form text.
metastoreId string
name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner string: Username/groupname/sp application_id of the external Location owner.
skipValidation boolean: Suppress validation errors if any & force save the external location

credential_name str: Name of the databricks.StorageCredential to use with this External Location.
url str: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
comment str: User-supplied free-form text.
metastore_id str
name str: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner str: Username/groupname/sp application_id of the external Location owner.
skip_validation bool: Suppress validation errors if any & force save the external location

credentialName String: Name of the databricks.StorageCredential to use with this External Location.
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).
comment String: User-supplied free-form text.
metastoreId String
name String: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner String: Username/groupname/sp application_id of the external Location owner.
skipValidation Boolean: Suppress validation errors if any & force save the external location

Outputs

All input properties are implicitly available as output properties. Additionally, the ExternalLocation 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 ExternalLocation Resource

Get an existing ExternalLocation 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?: ExternalLocationState, opts?: CustomResourceOptions): ExternalLocation

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        credential_name: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        skip_validation: Optional[bool] = None,
        url: Optional[str] = None) -> ExternalLocation

func GetExternalLocation(ctx *Context, name string, id IDInput, state *ExternalLocationState, opts ...ResourceOption) (*ExternalLocation, error)

public static ExternalLocation Get(string name, Input<string> id, ExternalLocationState? state, CustomResourceOptions? opts = null)

public static ExternalLocation get(String name, Output<String> id, ExternalLocationState 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:

Comment string: User-supplied free-form text.
CredentialName string: Name of the databricks.StorageCredential to use with this External Location.
MetastoreId string
Name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
Owner string: Username/groupname/sp application_id of the external Location owner.
SkipValidation bool: Suppress validation errors if any & force save the external location
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

Comment string: User-supplied free-form text.
CredentialName string: Name of the databricks.StorageCredential to use with this External Location.
MetastoreId string
Name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
Owner string: Username/groupname/sp application_id of the external Location owner.
SkipValidation bool: Suppress validation errors if any & force save the external location
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

comment String: User-supplied free-form text.
credentialName String: Name of the databricks.StorageCredential to use with this External Location.
metastoreId String
name String: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner String: Username/groupname/sp application_id of the external Location owner.
skipValidation Boolean: Suppress validation errors if any & force save the external location
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

comment string: User-supplied free-form text.
credentialName string: Name of the databricks.StorageCredential to use with this External Location.
metastoreId string
name string: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner string: Username/groupname/sp application_id of the external Location owner.
skipValidation boolean: Suppress validation errors if any & force save the external location
url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

comment str: User-supplied free-form text.
credential_name str: Name of the databricks.StorageCredential to use with this External Location.
metastore_id str
name str: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner str: Username/groupname/sp application_id of the external Location owner.
skip_validation bool: Suppress validation errors if any & force save the external location
url str: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

comment String: User-supplied free-form text.
credentialName String: Name of the databricks.StorageCredential to use with this External Location.
metastoreId String
name String: Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.
owner String: Username/groupname/sp application_id of the external Location owner.
skipValidation Boolean: Suppress validation errors if any & force save the external location
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure), gs://[bucket-host]/[bucket-dir] (GCP).

Import

This resource can be imported by namebash

 $ pulumi import databricks:index/externalLocation:ExternalLocation this <name>

Package Details

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