private_link_attachment_connections
Creates, updates, deletes, gets or lists a private_link_attachment_connections resource.
Overview
| Name | private_link_attachment_connections |
| Type | Resource |
| Id | confluent.networking.private_link_attachment_connections |
Fields
The following fields are returned by SELECT queries:
- get_networking_v1_private_link_attachment_connection
- list_networking_v1_private_link_attachment_connections
Private Link Attachment Connection.
| 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. (networking/v1) |
kind | string | Kind defines the object this REST resource represents. (PrivateLinkAttachmentConnection) |
metadata | object | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. |
spec | object | The desired state of the Private Link Attachment Connection |
status | object | The status of the Private Link Attachment Connection |
Private Link Attachment Connection.
| 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. (networking/v1) |
kind | string | Kind defines the object this REST resource represents. (PrivateLinkAttachmentConnection) |
metadata | object | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. |
spec | object | The desired state of the Private Link Attachment Connection |
status | object | The status of the Private Link Attachment Connection |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_networking_v1_private_link_attachment_connection | select | environment, id | Make a request to read a private link attachment connection. | |
list_networking_v1_private_link_attachment_connections | select | environment | spec.private_link_attachment, page_size, page_token | Retrieve a sorted, filtered, paginated list of all private link attachment connections. |
create_networking_v1_private_link_attachment_connection | insert | spec | Make a request to create a private link attachment connection. | |
update_networking_v1_private_link_attachment_connection | update | id, spec | Make a request to update a private link attachment connection. | |
delete_networking_v1_private_link_attachment_connection | delete | environment, id | Make a request to delete a private link attachment connection. |
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 |
|---|---|---|
environment | string | Scope the operation to the given environment. (example: env-00000) |
id | string | The unique identifier for the private link attachment connection. |
page_size | integer | A pagination size for collection requests. |
page_token | string | An opaque pagination token for collection requests. |
spec.private_link_attachment | string | Filter the results by exact match for spec.private_link_attachment. (example: platt-00000) |
SELECT examples
- get_networking_v1_private_link_attachment_connection
- list_networking_v1_private_link_attachment_connections
Make a request to read a private link attachment connection.
SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.private_link_attachment_connections
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;
Retrieve a sorted, filtered, paginated list of all private link attachment connections.
SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.private_link_attachment_connections
WHERE environment = '{{ environment }}' -- required
AND spec.private_link_attachment = '{{ spec.private_link_attachment }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;
INSERT examples
- create_networking_v1_private_link_attachment_connection
- Manifest
Make a request to create a private link attachment connection.
INSERT INTO confluent.networking.private_link_attachment_connections (
spec
)
SELECT
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;
# Description fields are for documentation purposes
- name: private_link_attachment_connections
props:
- name: spec
description: |
The desired state of the Private Link Attachment Connection
value:
display_name: "{{ display_name }}"
cloud:
kind: "{{ kind }}"
vpc_endpoint_id: "{{ vpc_endpoint_id }}"
private_endpoint_resource_id: "{{ private_endpoint_resource_id }}"
private_service_connect_connection_id: "{{ private_service_connect_connection_id }}"
environment:
id: "{{ id }}"
environment: "{{ environment }}"
related: "{{ related }}"
resource_name: "{{ resource_name }}"
api_version: "{{ api_version }}"
kind: "{{ kind }}"
private_link_attachment:
id: "{{ id }}"
environment: "{{ environment }}"
related: "{{ related }}"
resource_name: "{{ resource_name }}"
api_version: "{{ api_version }}"
kind: "{{ kind }}"
UPDATE examples
- update_networking_v1_private_link_attachment_connection
Make a request to update a private link attachment connection.
UPDATE confluent.networking.private_link_attachment_connections
SET
spec = '{{ spec }}'
WHERE
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;
DELETE examples
- delete_networking_v1_private_link_attachment_connection
Make a request to delete a private link attachment connection.
DELETE FROM confluent.networking.private_link_attachment_connections
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;