Skip to content

Improve clarity in resource gateway subnets requirements for ClickPipes RPE #4742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Improve clarity in resource gateway subnets requirements for ClickPipes RPE #4742

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6195e7
Improve clarity in resource gateway subnets requirements for ClickPip…
jkaflik Aug 29, 2025
3440088
fixing broken anchor id for linting
dhtclk Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions docs/integrations/data-ingestion/clickpipes/aws-privatelink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,38 +56,45 @@
2. Create a resource configuration
3. Create a resource share

#### 1. Create a Resource-Gateway {#create-resource-gateway}
#### 1. Create a resource gateway {#create-resource-gateway}

Resource-Gateway is the point that receives traffic for specified resources in your VPC.
Resource gateway is the point that receives traffic for specified resources in your VPC.

You can create a Resource-Gateway from the [AWS console](https://docs.aws.amazon.com/vpc/latest/privatelink/create-resource-gateway.html) or with the following command:
:::note
Your resource gateway attached subnets are recommended to have sufficient IP addresses available.
It's recommended to have at least `/26` subnet mask for each subnet.

For each VPC endpoint (each Reverse Private Endpoint), AWS requires a consecutive block of 16 IP addresses per subnet. (`/28` subnet mask)
:::

You can create a resource gateway from the [AWS console](https://docs.aws.amazon.com/vpc/latest/privatelink/create-resource gateway.html) or with the following command:

```bash
aws vpc-lattice create-resource-gateway \
aws vpc-lattice create-resource gateway \
Copy link
Contributor

@jgao54 jgao54 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hyphen is probably not intended to be removed, same as the other command in this PR

--vpc-identifier <VPC_ID> \
--subnet-ids <SUBNET_IDS> \
--security-group-ids <SG_IDs> \
--name <RESOURCE_GATEWAY_NAME>
```

The output will contain a Resource-Gateway id, which you will need for the next step.
The output will contain a resource gateway id, which you will need for the next step.

Check warning on line 80 in docs/integrations/data-ingestion/clickpipes/aws-privatelink.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense 

Instead of future tense 'will need', use present tense.

Check warning on line 80 in docs/integrations/data-ingestion/clickpipes/aws-privatelink.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense 

Instead of future tense 'will contain', use present tense.

Before you can proceed, you'll need to wait for the Resource-Gateway to enter into an `Active` state. You can check the state by running the following command:
Before you can proceed, you'll need to wait for the resource gateway to enter into an `Active` state. You can check the state by running the following command:

Check warning on line 82 in docs/integrations/data-ingestion/clickpipes/aws-privatelink.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.FutureTense 

Instead of future tense 'you'll need', use present tense.

```bash
aws vpc-lattice get-resource-gateway \
--resource-gateway-identifier <RESOURCE_GATEWAY_ID>
aws vpc-lattice get-resource gateway \
--resource gateway-identifier <RESOURCE_GATEWAY_ID>
```

#### 2. Create a VPC Resource-Configuration {#create-resource-configuration}

Resource-Configuration is associated with Resource-Gateway to make your resource accessible.
Resource-Configuration is associated with resource gateway to make your resource accessible.

You can create a Resource-Configuration from the [AWS console](https://docs.aws.amazon.com/vpc/latest/privatelink/create-resource-configuration.html) or with the following command:

```bash
aws vpc-lattice create-resource-configuration \
--resource-gateway-identifier <RESOURCE_GATEWAY_ID> \
--resource gateway-identifier <RESOURCE_GATEWAY_ID> \
--type <RESOURCE_CONFIGURATION_TYPE> \
--resource-configuration-definition <RESOURCE_CONFIGURATION_DEFINITION> \
--name <RESOURCE_CONFIGURATION_NAME>
Expand All @@ -101,7 +108,7 @@
aws vpc-lattice create-resource-configuration \
--name my-rds-cluster-config \
--type ARN \
--resource-gateway-identifier rgw-0bba03f3d56060135 \
--resource gateway-identifier rgw-0bba03f3d56060135 \
--resource-configuration-definition 'arnResource={arn=arn:aws:rds:us-east-1:123456789012:cluster:my-rds-cluster}'
```

Expand Down
Loading