shared_resources_network_config
Creates, updates, deletes, gets or lists a shared_resources_network_config resource.
Overview
| Name | shared_resources_network_config |
| Type | Resource |
| Id | confluent.stream_sharing.shared_resources_network_config |
Fields
The following fields are returned by SELECT queries:
- network_cdx_v1_consumer_shared_resource
The network information of the shared resource
| Name | Datatype | Description |
|---|---|---|
id | string | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de) |
api_version | string | APIVersion defines the schema version of this representation of a resource. (cdx/v1) |
cloud | object | The cloud-specific network details. These will be populated when the network reaches the READY state. |
dns_domain | string | The root DNS domain for the network if applicable. (example: 00000.us-east-1.aws.glb.confluent.cloud) |
kafka_bootstrap_url | string (uri) | The kafka cluster bootstrap url (example: SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092) |
kind | string | Kind defines the object this REST resource represents. (Network) |
metadata | object | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. |
zonal_subdomains | object | The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and values are DNS domains. |
zones | array | The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud. On AWS, zones are AWS AZ IDs (e.g. use1-az3) On GCP, zones are GCP zones (e.g. us-central1-c). On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not have universal zone identifiers. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
network_cdx_v1_consumer_shared_resource | select | id | Returns network information of the shared resource |
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 |
|---|---|---|
id | string | The unique identifier for the consumer shared resource. |
SELECT examples
- network_cdx_v1_consumer_shared_resource
Returns network information of the shared resource
SELECT
id,
api_version,
cloud,
dns_domain,
kafka_bootstrap_url,
kind,
metadata,
zonal_subdomains,
zones
FROM confluent.stream_sharing.shared_resources_network_config
WHERE id = '{{ id }}' -- required
;