ip_addresses
Creates, updates, deletes, gets or lists an ip_addresses resource.
Overview
| Name | ip_addresses |
| Type | Resource |
| Id | confluent.networking.ip_addresses |
Fields
The following fields are returned by SELECT queries:
- list_networking_v1_ip_addresses
IP Address.
| Name | Datatype | Description |
|---|---|---|
address_type | string | Whether the address is used for egress or ingress. (example: EGRESS) |
api_version | string | APIVersion defines the schema version of this representation of a resource. (networking/v1) |
cloud | string | The cloud service provider in which the address exists. (example: AWS) |
ip_prefix | string | The IP Address range. (pattern: ^\d+.\d+.\d+.\d+/\d+$, example: 10.200.0.0/28) |
kind | string | Kind defines the object this REST resource represents. (IpAddress) |
region | string | The region/location where the IP Address is in use. (example: us-east-1) |
services | array | The service types that will use the address. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_networking_v1_ip_addresses | select | cloud, region, services, address_type, page_size, page_token | Related guide: Use Public Egress IP addresses on Confluent Cloud Retrieve a sorted, filtered, paginated list of all IP Addresses. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
address_type | array | Filter the results by exact match for address_type. Pass multiple times to see results matching any of the values. (example: [INGRESS, EGRESS]) |
cloud | array | Filter the results by exact match for cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS]) |
page_size | integer | A pagination size for collection requests. |
page_token | string | An opaque pagination token for collection requests. |
region | array | Filter the results by exact match for region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1]) |
services | array | Filter the results by exact match for services. Pass multiple times to see results matching any of the values. (example: [KAFKA, CONNECT]) |
SELECT examples
- list_networking_v1_ip_addresses
Related guide: Use Public Egress IP addresses on Confluent Cloud
Retrieve a sorted, filtered, paginated list of all IP Addresses.
SELECT
address_type,
api_version,
cloud,
ip_prefix,
kind,
region,
services
FROM confluent.networking.ip_addresses
WHERE cloud = '{{ cloud }}'
AND region = '{{ region }}'
AND services = '{{ services }}'
AND address_type = '{{ address_type }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;