CREATE LOCATION (Amazon S3)
Reference and syntax for creating Amazon S3 locations.
Creates a new location object in your Firebolt account, which is a secure, reusable object that stores the connection details and credentials for Amazon S3 data sources. Instead of entering these details each time you run a query or create a table, you can use a location object.
This document captures specifics and examples for location objects for Amazon S3. For more on location objects in general, see CREATE LOCATION.
Topics:
Syntax
Parameters
Common Parameters
Parameter | Description |
---|---|
<location_name> | A unique identifier for the location within your account. |
SOURCE | The external data source type. Currently, AMAZON_S3 and ICEBERG are supported. This should be AMAZON_S3 for Amazon S3 locations. |
DESCRIPTION | Optional metadata describing the location’s purpose. |
Amazon S3 Parameters
Parameter | Description |
---|---|
SOURCE | Must be set to ‘AMAZON_S3’ for Amazon S3 locations. |
CREDENTIALS | Authentication credentials for Amazon S3 access. |
URL | The data source URL in the format: s3://{bucket_name}/{path} . This must be a valid S3 URL. |
AWS Authentication Parameters
Parameter | Description |
---|---|
AWS_ACCESS_KEY_ID | Your AWS access key ID for key-based authentication. |
AWS_SECRET_ACCESS_KEY | Your AWS secret access key for key-based authentication. |
AWS_SESSION_TOKEN | Optional temporary session token for temporary credentials. |
AWS_ROLE_ARN | The ARN of the IAM role to assume for role-based authentication. |
AWS_ROLE_EXTERNAL_ID | Optional external ID for role assumption. |
Examples
- Authenticate using an access key
- Authenticate using a role
- Create a location with an AWS session token
Authenticate using an access key
The following code example uses keys to authenticate to AWS:
Authenticate using a role
The following code example use a role to authenticate to AWS:
Create a location with an AWS session token
The following code example creates a location object named my_location
, for an Amazon S3 data source with the specified URL and AWS session token: