WITH clause when creating an Iceberg source, sink, or connection.
S3-compatible storage
These parameters configure the connection to an S3-compatible storage system, such as AWS S3 or MinIO, where your Iceberg data files are stored.| Parameter | Description |
|---|---|
warehouse.path | Required. The base path to your Iceberg warehouse. Example: 's3://my-bucket/iceberg-warehouse' |
s3.region | Required. The AWS region where the bucket is hosted. |
s3.access.key | Conditional. The AWS access key ID. |
s3.secret.key | Conditional. The AWS secret access key. |
s3.iam_role_arn | Optional. The IAM role ARN to assume for S3 access via STS. When set, the S3 FileIO layer assumes the specified role instead of using only the access key/secret pair, enabling tighter separation between object store access and other AWS permissions. |
s3.endpoint | Optional. The endpoint for S3-compatible services like MinIO. For AWS S3, this is typically not needed. |
s3.path.style.access | Optional. Set to true to use path-style access (e.g., for MinIO). Defaults to false for virtual-hosted–style access. |
In RisingWave Cloud, AWS credentials (
s3.access.key, s3.secret.key) are required and cannot be omitted. In self-hosted deployments, you may omit them to rely on the AWS SDK default credential chain (for example, EC2 instance profile or environment variables).Google Cloud Storage (GCS)
These parameters configure the connection to Google Cloud Storage.Support for GCS was added in RisingWave v2.3.0.
| Parameter | Description |
|---|---|
warehouse.path | Required. The GCS path to your warehouse. Example: 'gs://my-bucket/iceberg-warehouse' |
gcs.credential | Optional. The Base64-encoded credential key from a GCS service account JSON file. If not provided, Application Default Credentials (ADC) will be used. |
Example
Azure Blob Storage
These parameters configure the connection to Azure Blob Storage.Support for Azure Blob Storage was added in RisingWave v2.4.0.
| Parameter | Description |
|---|---|
warehouse.path | Required. The Azure Blob Storage path. Example: 'azblob://container-name/warehouse' |
azblob.account_name | Required. The Azure Storage account name. |
azblob.account_key | Required. The Azure Storage account key. |
azblob.endpoint_url | Optional. The endpoint URL for the Azure Blob service. Defaults to https://<account_name>.blob.core.windows.net/. |
Example
Azure Data Lake Storage Gen2 (ADLS)
These parameters configure the connection to Azure Data Lake Storage Gen2.Support for ADLS was added in RisingWave v2.5.0. ADLS can only be used with REST catalog.
| Parameter | Description |
|---|---|
warehouse.path | Required. The warehouse path. This is typically just the name of the container or a relative path. |
adlsgen2.account_name | Required. The Azure Storage account name. |
adlsgen2.account_key | Required. The Azure Storage account key. Alternatively, you can use client credentials (client ID, client secret, tenant ID) configured in your REST catalog. |
adlsgen2.endpoint | Optional. The endpoint URL for ADLS. Defaults to https://<account_name>.dfs.core.windows.net/. |
Example