mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-19 15:31:59 +00:00
27 lines
2.3 KiB
Markdown
27 lines
2.3 KiB
Markdown
|
---
|
||
|
|
title: Run Athena Connector using the CLI
|
||
|
|
slug: /metadata-ui/connectors/database/athena/cli
|
||
|
|
---
|
||
|
|
|
||
|
|
<ConnectorIntro connector="Athena" goal="CLI" hasProfiler="true" hasDBT="true"/>
|
||
|
|
|
||
|
|
<Requirements />
|
||
|
|
|
||
|
|
<MetadataIngestionServiceDev service="database" connector="BigQuery" goal="CLI"/>
|
||
|
|
|
||
|
|
<h4>Source Configuration - Service Connection</h4>
|
||
|
|
|
||
|
|
- **awsAccessKeyId**: Enter your secure access key ID for your Athena connection. The specified key ID should be authorized to read all databases you want to include in the metadata ingestion workflow.
|
||
|
|
- **awsSecretAccessKey**: Enter the Secret Access Key (the passcode key pair to the key ID from above).
|
||
|
|
- **awsRegion**: Enter the location of the amazon cluster that your data and account are associated with.
|
||
|
|
- **awsSessionToken**: The AWS session token is an optional parameter. If you want, enter the details of your temporary session token.
|
||
|
|
- **endPointURL**: Your Athena connector will automatically determine the AWS Athena endpoint URL based on the region. You may override this behavior by entering a value to the endpoint URL.
|
||
|
|
- **s3StagingDir**: The S3 staging directory is an optional parameter. Enter a staging dirrectory to override the default staging directory for AWS Athena.
|
||
|
|
- **workgroup**: The Athena workgroup is an optional parameter. If you wish to have your Athena connection related to an existing AWS workgroup add your workgroup name here.
|
||
|
|
- **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
|
||
|
|
- **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
|
||
|
|
- In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"`
|
||
|
|
- In case you authenticate with SSO using an external browser popup, then add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "externalbrowser"`
|
||
|
|
|
||
|
|
<MetadataIngestionConfig service="database" connector="Athena" goal="CLI" hasProfiler="true" hasDBT="true"/>
|