Databricks v1.50.2 published on Tuesday, Sep 24, 2024 by Pulumi
databricks.getExternalLocation
Explore with Pulumi AI
Note This data source can only be used with a workspace-level provider!
Retrieves details about a databricks.ExternalLocation that were created by Pulumi or manually.
Example Usage
Getting details of an existing external location in the metastore
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const this = databricks.getExternalLocation({
name: "this",
});
export const createdBy = _this.then(_this => _this.externalLocationInfo?.createdBy);
import pulumi
import pulumi_databricks as databricks
this = databricks.get_external_location(name="this")
pulumi.export("createdBy", this.external_location_info.created_by)
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
this, err := databricks.LookupExternalLocation(ctx, &databricks.LookupExternalLocationArgs{
Name: "this",
}, nil)
if err != nil {
return err
}
ctx.Export("createdBy", this.ExternalLocationInfo.CreatedBy)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = Databricks.GetExternalLocation.Invoke(new()
{
Name = "this",
});
return new Dictionary<string, object?>
{
["createdBy"] = @this.Apply(@this => @this.Apply(getExternalLocationResult => getExternalLocationResult.ExternalLocationInfo?.CreatedBy)),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetExternalLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var this = DatabricksFunctions.getExternalLocation(GetExternalLocationArgs.builder()
.name("this")
.build());
ctx.export("createdBy", this_.externalLocationInfo().createdBy());
}
}
variables:
this:
fn::invoke:
Function: databricks:getExternalLocation
Arguments:
name: this
outputs:
createdBy: ${this.externalLocationInfo.createdBy}
Related Resources
The following resources are used in the same context:
- databricks.getExternalLocations to get names of all external locations
- databricks.ExternalLocation to manage external locations within Unity Catalog.
Using getExternalLocation
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getExternalLocation(args: GetExternalLocationArgs, opts?: InvokeOptions): Promise<GetExternalLocationResult>
function getExternalLocationOutput(args: GetExternalLocationOutputArgs, opts?: InvokeOptions): Output<GetExternalLocationResult>
def get_external_location(external_location_info: Optional[GetExternalLocationExternalLocationInfo] = None,
id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetExternalLocationResult
def get_external_location_output(external_location_info: Optional[pulumi.Input[GetExternalLocationExternalLocationInfoArgs]] = None,
id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetExternalLocationResult]
func LookupExternalLocation(ctx *Context, args *LookupExternalLocationArgs, opts ...InvokeOption) (*LookupExternalLocationResult, error)
func LookupExternalLocationOutput(ctx *Context, args *LookupExternalLocationOutputArgs, opts ...InvokeOption) LookupExternalLocationResultOutput
> Note: This function is named LookupExternalLocation
in the Go SDK.
public static class GetExternalLocation
{
public static Task<GetExternalLocationResult> InvokeAsync(GetExternalLocationArgs args, InvokeOptions? opts = null)
public static Output<GetExternalLocationResult> Invoke(GetExternalLocationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetExternalLocationResult> getExternalLocation(GetExternalLocationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: databricks:index/getExternalLocation:getExternalLocation
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- The name of the external location
- External
Location GetInfo External Location External Location Info - array of objects with information about external location:
- Id string
- external location ID - same as name.
- Name string
- The name of the external location
- External
Location GetInfo External Location External Location Info - array of objects with information about external location:
- Id string
- external location ID - same as name.
- name String
- The name of the external location
- external
Location GetInfo External Location External Location Info - array of objects with information about external location:
- id String
- external location ID - same as name.
- name string
- The name of the external location
- external
Location GetInfo External Location External Location Info - array of objects with information about external location:
- id string
- external location ID - same as name.
- name str
- The name of the external location
- external_
location_ Getinfo External Location External Location Info - array of objects with information about external location:
- id str
- external location ID - same as name.
- name String
- The name of the external location
- external
Location Property MapInfo - array of objects with information about external location:
- id String
- external location ID - same as name.
getExternalLocation Result
The following output properties are available:
- External
Location GetInfo External Location External Location Info - array of objects with information about external location:
- Id string
- external location ID - same as name.
- Name string
- External
Location GetInfo External Location External Location Info - array of objects with information about external location:
- Id string
- external location ID - same as name.
- Name string
- external
Location GetInfo External Location External Location Info - array of objects with information about external location:
- id String
- external location ID - same as name.
- name String
- external
Location GetInfo External Location External Location Info - array of objects with information about external location:
- id string
- external location ID - same as name.
- name string
- external_
location_ Getinfo External Location External Location Info - array of objects with information about external location:
- id str
- external location ID - same as name.
- name str
- external
Location Property MapInfo - array of objects with information about external location:
- id String
- external location ID - same as name.
- name String
Supporting Types
GetExternalLocationExternalLocationInfo
- Access
Point string - The ARN of the s3 access point to use with the external location (AWS).
- Browse
Only bool - Comment string
- User-supplied comment.
- Created
At int - Time at which this catalog was created, in epoch milliseconds.
- Created
By string - Username of catalog creator.
- Credential
Id string - Unique ID of storage credential.
- Credential
Name string - Name of the databricks.StorageCredential to use with this external location.
- Encryption
Details GetExternal Location External Location Info Encryption Details - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Fallback bool
- Isolation
Mode string - Metastore
Id string - Unique identifier of the parent Metastore.
- Name string
- The name of the external location
- Owner string
- Username/groupname/sp application_id of the external location owner.
- Read
Only bool - Indicates whether the external location is read-only.
- Updated
At int - Time at which this catalog was last modified, in epoch milliseconds.
- Updated
By string - Username of user who last modified catalog.
- 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).
- Browse
Only bool - Comment string
- User-supplied comment.
- Created
At int - Time at which this catalog was created, in epoch milliseconds.
- Created
By string - Username of catalog creator.
- Credential
Id string - Unique ID of storage credential.
- Credential
Name string - Name of the databricks.StorageCredential to use with this external location.
- Encryption
Details GetExternal Location External Location Info Encryption Details - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- Fallback bool
- Isolation
Mode string - Metastore
Id string - Unique identifier of the parent Metastore.
- Name string
- The name of the external location
- Owner string
- Username/groupname/sp application_id of the external location owner.
- Read
Only bool - Indicates whether the external location is read-only.
- Updated
At int - Time at which this catalog was last modified, in epoch milliseconds.
- Updated
By string - Username of user who last modified catalog.
- 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).
- browse
Only Boolean - comment String
- User-supplied comment.
- created
At Integer - Time at which this catalog was created, in epoch milliseconds.
- created
By String - Username of catalog creator.
- credential
Id String - Unique ID of storage credential.
- credential
Name String - Name of the databricks.StorageCredential to use with this external location.
- encryption
Details GetExternal Location External Location Info Encryption Details - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- fallback Boolean
- isolation
Mode String - metastore
Id String - Unique identifier of the parent Metastore.
- name String
- The name of the external location
- owner String
- Username/groupname/sp application_id of the external location owner.
- read
Only Boolean - Indicates whether the external location is read-only.
- updated
At Integer - Time at which this catalog was last modified, in epoch milliseconds.
- updated
By String - Username of user who last modified catalog.
- 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).
- browse
Only boolean - comment string
- User-supplied comment.
- created
At number - Time at which this catalog was created, in epoch milliseconds.
- created
By string - Username of catalog creator.
- credential
Id string - Unique ID of storage credential.
- credential
Name string - Name of the databricks.StorageCredential to use with this external location.
- encryption
Details GetExternal Location External Location Info Encryption Details - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- fallback boolean
- isolation
Mode string - metastore
Id string - Unique identifier of the parent Metastore.
- name string
- The name of the external location
- owner string
- Username/groupname/sp application_id of the external location owner.
- read
Only boolean - Indicates whether the external location is read-only.
- updated
At number - Time at which this catalog was last modified, in epoch milliseconds.
- updated
By string - Username of user who last modified catalog.
- 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).
- browse_
only bool - comment str
- User-supplied comment.
- created_
at int - Time at which this catalog was created, in epoch milliseconds.
- created_
by str - Username of catalog creator.
- credential_
id str - Unique ID of storage credential.
- credential_
name str - Name of the databricks.StorageCredential to use with this external location.
- encryption_
details GetExternal Location External Location Info Encryption Details - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
- fallback bool
- isolation_
mode str - metastore_
id str - Unique identifier of the parent Metastore.
- name str
- The name of the external location
- owner str
- Username/groupname/sp application_id of the external location owner.
- read_
only bool - Indicates whether the external location is read-only.
- updated_
at int - Time at which this catalog was last modified, in epoch milliseconds.
- updated_
by str - Username of user who last modified catalog.
- 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).
- browse
Only Boolean - comment String
- User-supplied comment.
- created
At Number - Time at which this catalog was created, in epoch milliseconds.
- created
By String - Username of catalog creator.
- credential
Id String - Unique ID of storage credential.
- 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).
- fallback Boolean
- isolation
Mode String - metastore
Id String - Unique identifier of the parent Metastore.
- name String
- The name of the external location
- owner String
- Username/groupname/sp application_id of the external location owner.
- read
Only Boolean - Indicates whether the external location is read-only.
- updated
At Number - Time at which this catalog was last modified, in epoch milliseconds.
- updated
By String - Username of user who last modified catalog.
- 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).
GetExternalLocationExternalLocationInfoEncryptionDetails
GetExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails
- 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
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.