# The ExternalLocationInfo object

## Attributes

- `name` (string)
  Name of the external location.
- `url` (string)
  Path URL of the external location.
- `credential_name` (string)
  Name of the storage credential used with this location.
- `read_only` (boolean)
  Indicates whether the external location is read-only.
- `comment` (string)
  User-provided free-form text description.
- `enable_file_events` (boolean)
  Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.
   The actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.
- `file_event_queue` (object)
  File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.
  Example: `{"provided_sqs":{"queue_url":"https://sqs.us-west-1.amazonaws.com/123456789012/test-queue"}}` : Using a provided queue
  Example: `{"managed_sqs":{}}` : Using automatic queue creation
  - `provided_aqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}
       Only required for provided_aqs.
    - `subscription_id` (string)
      Optional subscription id for the queue, event grid subscription, and external location storage
       account.
       Required for locations with a service principal storage credential
    - `resource_group` (string)
      Optional resource group for the queue, event grid subscription, and external location storage
       account.
       Only required for locations with a service principal storage credential
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `provided_sqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.
       Only required for provided_sqs.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `provided_pubsub` (object)
    - `subscription_name` (string)
      The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.
       Only required for provided_pubsub.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_aqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}
       Only required for provided_aqs.
    - `subscription_id` (string)
      Optional subscription id for the queue, event grid subscription, and external location storage
       account.
       Required for locations with a service principal storage credential
    - `resource_group` (string)
      Optional resource group for the queue, event grid subscription, and external location storage
       account.
       Only required for locations with a service principal storage credential
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_sqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.
       Only required for provided_sqs.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_pubsub` (object)
    - `subscription_name` (string)
      The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.
       Only required for provided_pubsub.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
- `owner` (string)
  The owner of the external location.
- `encryption_details` (object)
  - `sse_encryption_details` (object)
    Server-Side Encryption properties for clients communicating with AWS s3.
    - `algorithm` (string)
      Sets the value of the 'x-amz-server-side-encryption' header in S3 request.
      Possible values: `SSE_ENCRYPTION_ALGORITHM_UNSPECIFIED`, `AWS_SSE_S3`, `AWS_SSE_KMS`
    - `aws_kms_key_arn` (string)
      Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = "SSE-KMS".
       Sets the value of the 'x-amz-server-side-encryption-aws-kms-key-id' header.
- `metastore_id` (string)
  Unique identifier of metastore hosting the external location.
- `credential_id` (string)
  Unique ID of the location's storage credential.
- `created_at` (int64)
  Time at which this external location was created, in epoch milliseconds.
- `created_by` (string)
  Username of external location creator.
- `updated_at` (int64)
  Time at which external location this was last modified, in epoch milliseconds.
- `updated_by` (string)
  Username of user who last modified the external location.
- `browse_only` (boolean)
  Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
- `isolation_mode` (string)
  Possible values: `ISOLATION_MODE_UNSPECIFIED`, `ISOLATION_MODE_OPEN`, `ISOLATION_MODE_ISOLATED`
- `fallback` (boolean)
  Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.
- `effective_enable_file_events` (boolean)
  The effective value of `enable_file_events` after applying server-side defaults.
- `effective_file_event_queue` (object)
  The effective file event queue configuration after applying server-side defaults.
   Always populated when a queue is provisioned, regardless of whether the user explicitly
   set `enable_file_events`. Use this field instead of `file_event_queue` for reading
   the actual queue state.
  - `provided_aqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}
       Only required for provided_aqs.
    - `subscription_id` (string)
      Optional subscription id for the queue, event grid subscription, and external location storage
       account.
       Required for locations with a service principal storage credential
    - `resource_group` (string)
      Optional resource group for the queue, event grid subscription, and external location storage
       account.
       Only required for locations with a service principal storage credential
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `provided_sqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.
       Only required for provided_sqs.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `provided_pubsub` (object)
    - `subscription_name` (string)
      The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.
       Only required for provided_pubsub.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_aqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}
       Only required for provided_aqs.
    - `subscription_id` (string)
      Optional subscription id for the queue, event grid subscription, and external location storage
       account.
       Required for locations with a service principal storage credential
    - `resource_group` (string)
      Optional resource group for the queue, event grid subscription, and external location storage
       account.
       Only required for locations with a service principal storage credential
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_sqs` (object)
    - `queue_url` (string)
      The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.
       Only required for provided_sqs.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.
  - `managed_pubsub` (object)
    - `subscription_name` (string)
      The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.
       Only required for provided_pubsub.
    - `managed_resource_id` (string)
      Unique identifier included in the name of file events managed cloud resources.

## Example

```json
{
  "name": "string",
  "url": "string",
  "credential_name": "string",
  "read_only": true,
  "comment": "string",
  "enable_file_events": true,
  "file_event_queue": {
    "provided_aqs": {},
    "provided_sqs": {},
    "provided_pubsub": {},
    "managed_aqs": {},
    "managed_sqs": {},
    "managed_pubsub": {}
  },
  "owner": "string",
  "encryption_details": {
    "sse_encryption_details": {}
  },
  "metastore_id": "string",
  "credential_id": "string",
  "created_at": 0,
  "created_by": "string",
  "updated_at": 0,
  "updated_by": "string",
  "browse_only": true,
  "isolation_mode": "string",
  "fallback": true,
  "effective_enable_file_events": true,
  "effective_file_event_queue": {
    "provided_aqs": {},
    "provided_sqs": {},
    "provided_pubsub": {},
    "managed_aqs": {},
    "managed_sqs": {},
    "managed_pubsub": {}
  }
}
```