databricks.getExternalLocation

Explore with Pulumi AI

Databricks v1.39.2 published on Friday, May 10, 2024 by Pulumi

pulumi/pulumi-databricks

Example Usage

Getting details of an existing external location in the metastore

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,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetExternalLocationResult
def get_external_location_output(external_location_info: Optional[pulumi.Input[GetExternalLocationExternalLocationInfoArgs]] = 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 storage credential
ExternalLocationInfo GetExternalLocationExternalLocationInfo

Name string: The name of the storage credential
ExternalLocationInfo GetExternalLocationExternalLocationInfo

name String: The name of the storage credential
externalLocationInfo GetExternalLocationExternalLocationInfo

name string: The name of the storage credential
externalLocationInfo GetExternalLocationExternalLocationInfo

name str: The name of the storage credential
external_location_info GetExternalLocationExternalLocationInfo

name String: The name of the storage credential
externalLocationInfo Property Map

getExternalLocation Result

The following output properties are available:

ExternalLocationInfo GetExternalLocationExternalLocationInfo
Id string: The provider-assigned unique ID for this managed resource.
Name string

ExternalLocationInfo GetExternalLocationExternalLocationInfo
Id string: The provider-assigned unique ID for this managed resource.
Name string

externalLocationInfo GetExternalLocationExternalLocationInfo
id String: The provider-assigned unique ID for this managed resource.
name String

externalLocationInfo GetExternalLocationExternalLocationInfo
id string: The provider-assigned unique ID for this managed resource.
name string

external_location_info GetExternalLocationExternalLocationInfo
id str: The provider-assigned unique ID for this managed resource.
name str

externalLocationInfo Property Map
id String: The provider-assigned unique ID for this managed resource.
name String

Supporting Types

GetExternalLocationExternalLocationInfo

AccessPoint string: The ARN of the s3 access point to use with the external location (AWS).
BrowseOnly bool
Comment string: User-supplied comment.
CreatedAt int
CreatedBy string
CredentialId string
CredentialName string: Name of the databricks.StorageCredential to use with this external location.
EncryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
MetastoreId string
Name string: The name of the storage credential
Owner string: Username/groupname/sp application_id of the external location owner.
ReadOnly bool: Indicates whether the external location is read-only.
UpdatedAt int
UpdatedBy string
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).

AccessPoint string: The ARN of the s3 access point to use with the external location (AWS).
BrowseOnly bool
Comment string: User-supplied comment.
CreatedAt int
CreatedBy string
CredentialId string
CredentialName string: Name of the databricks.StorageCredential to use with this external location.
EncryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
MetastoreId string
Name string: The name of the storage credential
Owner string: Username/groupname/sp application_id of the external location owner.
ReadOnly bool: Indicates whether the external location is read-only.
UpdatedAt int
UpdatedBy string
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).

accessPoint String: The ARN of the s3 access point to use with the external location (AWS).
browseOnly Boolean
comment String: User-supplied comment.
createdAt Integer
createdBy String
credentialId String
credentialName String: Name of the databricks.StorageCredential to use with this external location.
encryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
metastoreId String
name String: The name of the storage credential
owner String: Username/groupname/sp application_id of the external location owner.
readOnly Boolean: Indicates whether the external location is read-only.
updatedAt Integer
updatedBy String
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).

accessPoint string: The ARN of the s3 access point to use with the external location (AWS).
browseOnly boolean
comment string: User-supplied comment.
createdAt number
createdBy string
credentialId string
credentialName string: Name of the databricks.StorageCredential to use with this external location.
encryptionDetails GetExternalLocationExternalLocationInfoEncryptionDetails: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
metastoreId string
name string: The name of the storage credential
owner string: Username/groupname/sp application_id of the external location owner.
readOnly boolean: Indicates whether the external location is read-only.
updatedAt number
updatedBy string
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
created_by str
credential_id str
credential_name str: Name of the databricks.StorageCredential to use with this external location.
encryption_details GetExternalLocationExternalLocationInfoEncryptionDetails: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
metastore_id str
name str: The name of the storage credential
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
updated_by str
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).

accessPoint String: The ARN of the s3 access point to use with the external location (AWS).
browseOnly Boolean
comment String: User-supplied comment.
createdAt Number
createdBy String
credentialId String
credentialName String: Name of the databricks.StorageCredential to use with this external location.
encryptionDetails Property Map: The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
metastoreId String
name String: The name of the storage credential
owner String: Username/groupname/sp application_id of the external location owner.
readOnly Boolean: Indicates whether the external location is read-only.
updatedAt Number
updatedBy String
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).