Accessing S3 data securely

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/guides/data_sources/02_accessing-s3-data-securely.md)

This guide demonstrates how ClickHouse Cloud customers can leverage role-based access to authenticate with Amazon Simple Storage Service (S3) and access their data securely.
Before diving into the setup for secure S3 access, it is important to understand how this works. Below is an overview of how ClickHouse services can access private S3 buckets by assuming a role within customers' AWS account.

  

This approach allows customers to manage all access to their S3 buckets in a single place (the IAM policy of the assumed-role) without having to go through all of their bucket policies to add or remove access.
In the section below, you will learn how to set this up.

## Obtain the IAM role ARN of your ClickHouse service[​](#obtaining-the-clickhouse-service-iam-role-arn "Direct link to Obtain the IAM role ARN of your ClickHouse service")

1. Login to your ClickHouse cloud account.
2. Select the ClickHouse service you want to create the integration
3. Select the **Settings** tab
4. Scroll down to the **Network security information** section at the bottom of the page
5. Copy the **Service role ID (IAM)** value belong to the service as shown below.

## Set up IAM assume role[​](#setting-up-iam-assume-role "Direct link to Set up IAM assume role")

The IAM assume role can be setup in one of two ways:

- [Using CloudFormation stack](#option-1-deploying-with-cloudformation-stack)
- [Manually creating an IAM role](#option-2-manually-create-iam-role)

### Deploying with CloudFormation stack[​](#option-1-deploying-with-cloudformation-stack "Direct link to Deploying with CloudFormation stack")

1. Login to your AWS Account in the web browser with an IAM user that has permission to create & manage IAM role.
2. Visit the following [CloudFormation URL](https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/quickcreate?templateURL=https://s3.us-east-2.amazonaws.com/clickhouse-public-resources.clickhouse.cloud/cf-templates/secure-s3.yaml&stackName=ClickHouseSecureS3) to populate the CloudFormation stack.
3. Enter (or paste) the **service role ID (IAM)** for your service that you obtained earlier into the input titled "ClickHouse Instance Roles"
   You can paste the service role ID exactly as it appears in Cloud console.
4. Enter your bucket name in the input titled "Bucket Names". If your bucket URL is `https://ch-docs-s3-bucket.s3.eu-central-1.amazonaws.com/clickhouseS3/` then the bucket name is `ch-docs-s3-bucket`.

Note

Don't put the full bucket ARN but instead just the bucket name only.

5. Configure the CloudFormation stack. Below is additional information about these parameters.

|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| Parameter Default Value Description|  |  |  |  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | RoleName ClickHouseAccess-001 The name of the new role that ClickHouse Cloud will use to access your S3 bucket.|  |  |  |  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Role Session Name \* Role Session Name can be used as a shared secret to further protect your bucket.|  |  |  |  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | --- | --- | --- | | ClickHouse Instance Roles Comma-separated list of ClickHouse service IAM roles that can use this secure S3 integration.|  |  |  |  |  |  | | --- | --- | --- | --- | --- | --- | | Bucket Access Read Sets the level of access for the provided buckets.|  |  |  | | --- | --- | --- | | Bucket Names Comma-separated list of bucket names that this role will have access to. **Note:** use the bucket name, not the full bucket ARN. | | | | | | | | | | | | | | | | | |

6. Select the **I acknowledge that AWS CloudFormation might create IAM resources with custom names.** checkbox
7. Click the **Create stack** button at the bottom right
8. Make sure the CloudFormation stack completes with no error.
9. Select the newly created Stack then select the **Outputs** tab of the CloudFormation stack
10. Copy the **RoleArn** value for this integration, which is what you need to access your S3 bucket.

### Manually create IAM role[​](#option-2-manually-create-iam-role "Direct link to Manually create IAM role")

1. Login to your AWS Account in the web browser with an IAM user that has permission to create & manage IAM role.
2. Browse to the IAM Service Console
3. Create a new IAM role with the following IAM & Trust policy. Replace `{ClickHouse_IAM_ARN}` with the IAM Role arn belong to your ClickHouse instance.

```
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "{ClickHouse_IAM_ARN}"
            },
            "Action": "sts:AssumeRole"
        }
    ]
}
```

**IAM policy**

```
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "s3:GetBucketLocation",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::{BUCKET_NAME}"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "s3:Get*",
                "s3:List*"
            ],
            "Resource": [
                "arn:aws:s3:::{BUCKET_NAME}/*"
            ],
            "Effect": "Allow"
        }
    ]
}
```

4. Copy the new **IAM Role Arn** after creation, which is what's needed to access your S3 bucket.

## Access your S3 bucket with the ClickHouseAccess role[​](#access-your-s3-bucket-with-the-clickhouseaccess-role "Direct link to Access your S3 bucket with the ClickHouseAccess role")

ClickHouse Cloud allows you to specify `extra_credentials` as part of the S3 table function.
Below is an example of how to run a query using the newly created role copied from above.

```
DESCRIBE TABLE s3('https://s3.amazonaws.com/BUCKETNAME/BUCKETOBJECT.csv','CSVWithNames',extra_credentials(role_arn = 'arn:aws:iam::111111111111:role/ClickHouseAccessRole-001'))
```

Below is an example query that uses the `role_session_name` as a shared secret to query data from a bucket.
If the `role_session_name` isn't correct, this operation will fail.

```
DESCRIBE TABLE s3('https://s3.amazonaws.com/BUCKETNAME/BUCKETOBJECT.csv','CSVWithNames',extra_credentials(role_arn = 'arn:aws:iam::111111111111:role/ClickHouseAccessRole-001', role_session_name = 'secret-role-name'))
```

Note

We recommend that your source S3 is in the same region as your ClickHouse Cloud Service to reduce on data transfer costs.
For more information, refer to [S3 pricing](https://aws.amazon.com/s3/pricing/)

## Advanced action control[​](#advanced-action-control "Direct link to Advanced action control")

For stricter access control, it's possible to restrict the bucket policy to only accept requests that originate from ClickHouse Cloud's VPC endpoints using the [`aws:SourceVpce` condition](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies-vpc-endpoint.html#example-bucket-policies-restrict-accesss-vpc-endpoint). To obtain the VPC endpoints for your ClickHouse Cloud region, open a terminal and run:

```
# Replace <your-region> with your ClickHouse Cloud region
curl -s https://api.clickhouse.cloud/static-ips.json | jq -r '.aws[] | select(.region == "<your-region>") | .s3_endpoints[]'
```

Then, add a deny rule to the IAM policy with the returned endpoints: