> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Step-by-step guide to create your first Amazon S3 ClickPipe.

# Creating your first Amazon S3 ClickPipe

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

export const props_0 = undefined

export const provider_0 = "s3"

The S3 ClickPipe provides a fully-managed and resilient way to ingest data from Amazon S3 and S3-compatible object stores into ClickHouse Cloud. It supports both **one-time** and **continuous ingestion** with exactly-once semantics.

<Steps>
  <Step>
    <h2 id="1-select-the-data-source">
      Select the data source
    </h2>

    **1.** In ClickHouse Cloud, select **Data sources** in the main navigation menu and click **Create ClickPipe**.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step0.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=3a59ce71568eecec94d17e9947e9d2ea" alt="Select imports" size="lg" border width="2606" height="790" data-path="images/integrations/data-ingestion/clickpipes/cp_step0.png" />

    {props_0.provider_0 === 's3' && <S3DataSource />}

    {props_0.provider_0 === 'gcs' && <GCSSDataSource />}
  </Step>

  <Step>
    <h2 id="2-setup-your-clickpipe-connection">
      Setup your ClickPipe connection
    </h2>

    **1.** To setup a new ClickPipe, you must provide details on how to connect to and authenticate with your object storage service.

    {props_0.provider_0 === 's3' && <S3Connection />}

    {props_0.provider_0 === 'gcs' && <GCSConnection />}

    **2.** Click **Incoming data**. ClickPipes will fetch metadata from your bucket for the next step.
  </Step>

  <Step>
    <h2 id="3-select-data-format">
      Select data format
    </h2>

    The UI will display a list of files in the specified bucket.
    Select your data format (we currently support a subset of ClickHouse formats) and if you want to enable continuous ingestion.
    See the "continuous ingest" section in the overview page for more details.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step3_object_storage.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=254adde2855ecdbff1de4aa7229eb6a4" alt="Set data format and topic" size="lg" border width="2336" height="1566" data-path="images/integrations/data-ingestion/clickpipes/cp_step3_object_storage.png" />
  </Step>

  <Step>
    <h2 id="5-configure-table-schema-settings">
      Configure table, schema and settings
    </h2>

    In the next step, you can select whether you want to ingest data into a new ClickHouse table or reuse an existing one.
    Follow the instructions in the screen to modify your table name, schema, and settings.
    You can see a real-time preview of your changes in the sample table at the top.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step4a.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=3c9883ec4227355722c6ed50a7cf8095" alt="Set table, schema, and settings" size="lg" border width="2734" height="1328" data-path="images/integrations/data-ingestion/clickpipes/cp_step4a.png" />

    You can also customize the advanced settings using the controls provided

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step4a3.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=fd33708945057dfc2768f048f68ed8eb" alt="Set advanced controls" size="lg" border width="1592" height="338" data-path="images/integrations/data-ingestion/clickpipes/cp_step4a3.png" />

    Alternatively, you can decide to ingest your data in an existing ClickHouse table.
    In that case, the UI will allow you to map fields from the source to the ClickHouse fields in the selected destination table.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step4b.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=b92de2472fc055d7f67143076f4f517b" alt="Use an existing table" size="lg" border width="2738" height="1322" data-path="images/integrations/data-ingestion/clickpipes/cp_step4b.png" />

    <Info>
      You can also map [virtual columns](/reference/functions/table-functions/s3#virtual-columns), like `_path` or `_size`, to fields.
    </Info>
  </Step>

  <Step>
    <h2 id="6-configure-permissions">
      Configure permissions
    </h2>

    Finally, you can configure permissions for the internal ClickPipes user.

    **Permissions:** ClickPipes will create a dedicated user for writing data into a destination table. You can select a role for this internal user using a custom role or one of the predefined role:

    * `Full access`: with the full access to the cluster. Required if you use materialized view or Dictionary with the destination table.
    * `Only destination table`: with the `INSERT` permissions to the destination table only.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_step5.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=a3503c69f33c008da51d63de4cf65e6a" alt="Permissions" size="lg" border width="2736" height="1318" data-path="images/integrations/data-ingestion/clickpipes/cp_step5.png" />
  </Step>

  <Step>
    <h2 id="7-complete-setup">
      Complete setup
    </h2>

    By clicking on "Complete Setup", the system will register your ClickPipe, and you'll be able to see it listed in the summary table.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_success.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=cee5f37a4686d3c921f1d1a4d7abaa59" alt="Success notice" size="sm" border width="613" height="212" data-path="images/integrations/data-ingestion/clickpipes/cp_success.png" />

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_remove.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=511ae0199b78cc29da0ebf8af899d7d0" alt="Remove notice" size="lg" border width="2756" height="1320" data-path="images/integrations/data-ingestion/clickpipes/cp_remove.png" />

    The summary table provides controls to display sample data from the source or the destination table in ClickHouse

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_destination.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=82d019381204d6bb4b81f5aa8aa73040" alt="View destination" size="lg" border width="2758" height="1316" data-path="images/integrations/data-ingestion/clickpipes/cp_destination.png" />

    As well as controls to remove the ClickPipe and display a summary of the ingest job.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/2Zeerd64Tl5ZAQUa/images/integrations/data-ingestion/clickpipes/cp_overview.png?fit=max&auto=format&n=2Zeerd64Tl5ZAQUa&q=85&s=6d487bf61a638698b1d379862e72746b" alt="View overview" size="lg" border width="3436" height="1076" data-path="images/integrations/data-ingestion/clickpipes/cp_overview.png" />

    **Congratulations!** you have successfully set up your first ClickPipe.
    If this is a ClickPipe configure for continuous ingestion, it will be continuously running, ingesting data in real-time from your remote data source.
    Otherwise, it will ingest the batch and complete.
  </Step>
</Steps>
