|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "konnect_gateway_control_plane_list Data Source - terraform-provider-konnect" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + GatewayControlPlaneList DataSource |
| 7 | +--- |
| 8 | + |
| 9 | +# konnect_gateway_control_plane_list (Data Source) |
| 10 | + |
| 11 | +GatewayControlPlaneList DataSource |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +data "konnect_gateway_control_plane_list" "my_gatewaycontrolplanelist" { |
| 17 | + filter = { |
| 18 | + cloud_gateway = true |
| 19 | + cluster_type = { |
| 20 | + eq = "...my_eq..." |
| 21 | + neq = "...my_neq..." |
| 22 | + } |
| 23 | + id = { |
| 24 | + eq = "...my_eq..." |
| 25 | + oeq = "...my_oeq..." |
| 26 | + } |
| 27 | + name = { |
| 28 | + contains = "...my_contains..." |
| 29 | + eq = "...my_eq..." |
| 30 | + neq = "...my_neq..." |
| 31 | + } |
| 32 | + } |
| 33 | + filter_labels = "key:value,existCheck" |
| 34 | + sort = "created_at desc" |
| 35 | +} |
| 36 | +``` |
| 37 | + |
| 38 | +<!-- schema generated by tfplugindocs --> |
| 39 | +## Schema |
| 40 | + |
| 41 | +### Optional |
| 42 | + |
| 43 | +- `filter` (Attributes) Filters a collection of control-planes. (see [below for nested schema](#nestedatt--filter)) |
| 44 | +- `filter_labels` (String) Filter control planes in the response by associated labels. |
| 45 | +- `sort` (String) Sorts a collection of control-planes. Supported sort attributes are: |
| 46 | + - created_at |
| 47 | + |
| 48 | +### Read-Only |
| 49 | + |
| 50 | +- `data` (Attributes List) (see [below for nested schema](#nestedatt--data)) |
| 51 | + |
| 52 | +<a id="nestedatt--filter"></a> |
| 53 | +### Nested Schema for `filter` |
| 54 | + |
| 55 | +Optional: |
| 56 | + |
| 57 | +- `cloud_gateway` (Boolean) Filter by a boolean value (true/false). |
| 58 | +- `cluster_type` (Attributes) Filters on the given string field value by exact match inequality. (see [below for nested schema](#nestedatt--filter--cluster_type)) |
| 59 | +- `id` (Attributes) Returns entities that exact match any of the comma-delimited phrases in the filter string. (see [below for nested schema](#nestedatt--filter--id)) |
| 60 | +- `name` (Attributes) Filters on the given string field value by exact match inequality. (see [below for nested schema](#nestedatt--filter--name)) |
| 61 | + |
| 62 | +<a id="nestedatt--filter--cluster_type"></a> |
| 63 | +### Nested Schema for `filter.cluster_type` |
| 64 | + |
| 65 | +Optional: |
| 66 | + |
| 67 | +- `eq` (String) |
| 68 | +- `neq` (String) |
| 69 | + |
| 70 | + |
| 71 | +<a id="nestedatt--filter--id"></a> |
| 72 | +### Nested Schema for `filter.id` |
| 73 | + |
| 74 | +Optional: |
| 75 | + |
| 76 | +- `eq` (String) |
| 77 | +- `oeq` (String) |
| 78 | + |
| 79 | + |
| 80 | +<a id="nestedatt--filter--name"></a> |
| 81 | +### Nested Schema for `filter.name` |
| 82 | + |
| 83 | +Optional: |
| 84 | + |
| 85 | +- `contains` (String) |
| 86 | +- `eq` (String) |
| 87 | +- `neq` (String) |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | +<a id="nestedatt--data"></a> |
| 92 | +### Nested Schema for `data` |
| 93 | + |
| 94 | +Read-Only: |
| 95 | + |
| 96 | +- `config` (Attributes) CP configuration object for related access endpoints. (see [below for nested schema](#nestedatt--data--config)) |
| 97 | +- `description` (String) The description of the control plane in Konnect. |
| 98 | +- `id` (String) The control plane ID. |
| 99 | +- `labels` (Map of String) Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. |
| 100 | + |
| 101 | +Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". |
| 102 | +- `name` (String) The name of the control plane. |
| 103 | + |
| 104 | +<a id="nestedatt--data--config"></a> |
| 105 | +### Nested Schema for `data.config` |
| 106 | + |
| 107 | +Read-Only: |
| 108 | + |
| 109 | +- `auth_type` (String) The auth type value of the cluster associated with the Runtime Group. |
| 110 | +- `cloud_gateway` (Boolean) Whether the Control Plane can be used for cloud-gateways. |
| 111 | +- `cluster_type` (String) The ClusterType value of the cluster associated with the Control Plane. |
| 112 | +- `control_plane_endpoint` (String) Control Plane Endpoint. |
| 113 | +- `proxy_urls` (Attributes Set) Array of proxy URLs associated with reaching the data-planes connected to a control-plane. (see [below for nested schema](#nestedatt--data--config--proxy_urls)) |
| 114 | +- `telemetry_endpoint` (String) Telemetry Endpoint. |
| 115 | + |
| 116 | +<a id="nestedatt--data--config--proxy_urls"></a> |
| 117 | +### Nested Schema for `data.config.proxy_urls` |
| 118 | + |
| 119 | +Read-Only: |
| 120 | + |
| 121 | +- `host` (String) Hostname of the proxy URL. |
| 122 | +- `port` (Number) Port of the proxy URL. |
| 123 | +- `protocol` (String) Protocol of the proxy URL. |
0 commit comments