databricks.ExternalLocation
Explore with Pulumi AI
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,
access_point: Optional[str] = None,
comment: Optional[str] = None,
credential_name: Optional[str] = None,
encryption_details: Optional[ExternalLocationEncryptionDetailsArgs] = None,
force_destroy: Optional[bool] = None,
force_update: Optional[bool] = None,
metastore_id: Optional[str] = None,
name: Optional[str] = None,
owner: Optional[str] = None,
read_only: Optional[bool] = 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:
- Credential
Name 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).- Access
Point string The ARN of the s3 access point to use with the external location (AWS).
- Comment string
User-supplied free-form text.
- Encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Force
Destroy bool Destroy external location regardless of its dependents.
- Force
Update bool Update external location regardless of its dependents.
- Metastore
Id 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.
- Read
Only bool Indicates whether the external location is read-only.
- Skip
Validation bool Suppress validation errors if any & force save the external location
- Credential
Name 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).- Access
Point string The ARN of the s3 access point to use with the external location (AWS).
- Comment string
User-supplied free-form text.
- Encryption
Details ExternalLocation Encryption Details Args The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Force
Destroy bool Destroy external location regardless of its dependents.
- Force
Update bool Update external location regardless of its dependents.
- Metastore
Id 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.
- Read
Only bool Indicates whether the external location is read-only.
- Skip
Validation bool Suppress validation errors if any & force save the external location
- credential
Name 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).- access
Point String The ARN of the s3 access point to use with the external location (AWS).
- comment String
User-supplied free-form text.
- encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy Boolean Destroy external location regardless of its dependents.
- force
Update Boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only Boolean Indicates whether the external location is read-only.
- skip
Validation Boolean Suppress validation errors if any & force save the external location
- credential
Name 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).- access
Point string The ARN of the s3 access point to use with the external location (AWS).
- comment string
User-supplied free-form text.
- encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy boolean Destroy external location regardless of its dependents.
- force
Update boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only boolean Indicates whether the external location is read-only.
- skip
Validation 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).- access_
point str The ARN of the s3 access point to use with the external location (AWS).
- comment str
User-supplied free-form text.
- encryption_
details ExternalLocation Encryption Details Args The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force_
destroy bool Destroy external location regardless of its dependents.
- force_
update bool Update external location regardless of its dependents.
- 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.
- read_
only bool Indicates whether the external location is read-only.
- skip_
validation bool Suppress validation errors if any & force save the external location
- credential
Name 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).- access
Point String The ARN of the s3 access point to use with the external location (AWS).
- comment String
User-supplied free-form text.
- encryption
Details Property Map The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy Boolean Destroy external location regardless of its dependents.
- force
Update Boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only Boolean Indicates whether the external location is read-only.
- skip
Validation 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,
access_point: Optional[str] = None,
comment: Optional[str] = None,
credential_name: Optional[str] = None,
encryption_details: Optional[ExternalLocationEncryptionDetailsArgs] = None,
force_destroy: Optional[bool] = None,
force_update: Optional[bool] = None,
metastore_id: Optional[str] = None,
name: Optional[str] = None,
owner: Optional[str] = None,
read_only: Optional[bool] = 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.
- Access
Point string The ARN of the s3 access point to use with the external location (AWS).
- Comment string
User-supplied free-form text.
- Credential
Name string Name of the databricks.StorageCredential to use with this external location.
- Encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Force
Destroy bool Destroy external location regardless of its dependents.
- Force
Update bool Update external location regardless of its dependents.
- Metastore
Id 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.
- Read
Only bool Indicates whether the external location is read-only.
- Skip
Validation 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).
- Access
Point string The ARN of the s3 access point to use with the external location (AWS).
- Comment string
User-supplied free-form text.
- Credential
Name string Name of the databricks.StorageCredential to use with this external location.
- Encryption
Details ExternalLocation Encryption Details Args The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Force
Destroy bool Destroy external location regardless of its dependents.
- Force
Update bool Update external location regardless of its dependents.
- Metastore
Id 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.
- Read
Only bool Indicates whether the external location is read-only.
- Skip
Validation 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).
- access
Point String The ARN of the s3 access point to use with the external location (AWS).
- comment String
User-supplied free-form text.
- credential
Name String Name of the databricks.StorageCredential to use with this external location.
- encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy Boolean Destroy external location regardless of its dependents.
- force
Update Boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only Boolean Indicates whether the external location is read-only.
- skip
Validation 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).
- access
Point string The ARN of the s3 access point to use with the external location (AWS).
- comment string
User-supplied free-form text.
- credential
Name string Name of the databricks.StorageCredential to use with this external location.
- encryption
Details ExternalLocation Encryption Details The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy boolean Destroy external location regardless of its dependents.
- force
Update boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only boolean Indicates whether the external location is read-only.
- skip
Validation 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).
- access_
point str The ARN of the s3 access point to use with the external location (AWS).
- comment str
User-supplied free-form text.
- credential_
name str Name of the databricks.StorageCredential to use with this external location.
- encryption_
details ExternalLocation Encryption Details Args The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force_
destroy bool Destroy external location regardless of its dependents.
- force_
update bool Update external location regardless of its dependents.
- 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.
- read_
only bool Indicates whether the external location is read-only.
- 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).
- access
Point String The ARN of the s3 access point to use with the external location (AWS).
- comment String
User-supplied free-form text.
- credential
Name String Name of the databricks.StorageCredential to use with this external location.
- encryption
Details Property Map The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- force
Destroy Boolean Destroy external location regardless of its dependents.
- force
Update Boolean Update external location regardless of its dependents.
- metastore
Id 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.
- read
Only Boolean Indicates whether the external location is read-only.
- skip
Validation 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).
Supporting Types
ExternalLocationEncryptionDetails, ExternalLocationEncryptionDetailsArgs
ExternalLocationEncryptionDetailsSseEncryptionDetails, ExternalLocationEncryptionDetailsSseEncryptionDetailsArgs
- Algorithm string
- Aws
Kms stringKey Arn
- Algorithm string
- Aws
Kms stringKey Arn
- algorithm String
- aws
Kms StringKey Arn
- algorithm string
- aws
Kms stringKey Arn
- algorithm str
- aws_
kms_ strkey_ arn
- algorithm String
- aws
Kms StringKey Arn
Import
This resource can be imported by name
bash
$ 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.