databricks.ExternalLocation (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

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

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

Constructor syntax

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

@overload
def ExternalLocation(resource_name: str,
                     args: ExternalLocationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ExternalLocation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     credential_name: Optional[str] = None,
                     url: Optional[str] = None,
                     comment: Optional[str] = None,
                     metastore_id: Optional[str] = None,
                     name: Optional[str] = None,
                     owner: Optional[str] = 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.

Parameters

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.

Constructor example

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

var externalLocationResource = new Databricks.ExternalLocation("externalLocationResource", new()
{
    CredentialName = "string",
    Url = "string",
    Comment = "string",
    MetastoreId = "string",
    Name = "string",
    Owner = "string",
});

example, err := databricks.NewExternalLocation(ctx, "externalLocationResource", &databricks.ExternalLocationArgs{
	CredentialName: pulumi.String("string"),
	Url:            pulumi.String("string"),
	Comment:        pulumi.String("string"),
	MetastoreId:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	Owner:          pulumi.String("string"),
})

var externalLocationResource = new ExternalLocation("externalLocationResource", ExternalLocationArgs.builder()
    .credentialName("string")
    .url("string")
    .comment("string")
    .metastoreId("string")
    .name("string")
    .owner("string")
    .build());

external_location_resource = databricks.ExternalLocation("externalLocationResource",
    credential_name="string",
    url="string",
    comment="string",
    metastore_id="string",
    name="string",
    owner="string")

const externalLocationResource = new databricks.ExternalLocation("externalLocationResource", {
    credentialName: "string",
    url: "string",
    comment: "string",
    metastoreId: "string",
    name: "string",
    owner: "string",
});

type: databricks:ExternalLocation
properties:
    comment: string
    credentialName: string
    metastoreId: string
    name: string
    owner: string
    url: string

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

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

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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).
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 of External Location owner. Currently this field can only be changed after the resource is created.

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

resources:  _:    type: databricks:ExternalLocation    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:

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 of External Location owner. Currently this field can only be changed after the resource is created.
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

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 of External Location owner. Currently this field can only be changed after the resource is created.
Url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

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 of External Location owner. Currently this field can only be changed after the resource is created.
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

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 of External Location owner. Currently this field can only be changed after the resource is created.
url string: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

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 of External Location owner. Currently this field can only be changed after the resource is created.
url str: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

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 of External Location owner. Currently this field can only be changed after the resource is created.
url String: Path URL in cloud storage, of the form: s3://[bucket-host]/[bucket-dir] (AWS), abfss://[user]@[host]/[path] (Azure).

Import

This resource can be imported by namebash

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

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.

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.ExternalLocation

On this page

On this page

Create ExternalLocation Resource

Constructor syntax

Parameters

Constructor example

ExternalLocation Resource Properties

Inputs

Outputs

Look up Existing ExternalLocation Resource

Import

Package Details

On this page

On this page