private_link_attachments

Creates, updates, deletes, gets or lists a private_link_attachments resource.

Overview

Name	private_link_attachments
Type	Resource
Id	confluent.networking.private_link_attachments

Fields

The following fields are returned by SELECT queries:

get_networking_v1_private_link_attachment

Private Link Attachment.

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. (PrivateLinkAttachment)
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
status	object	The status of the Private Link Attachment

list_networking_v1_private_link_attachments

Private Link Attachment.

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. (PrivateLinkAttachment)
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
status	object	The status of the Private Link Attachment

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_networking_v1_private_link_attachment	select	environment, id		Make a request to read a private link attachment.
list_networking_v1_private_link_attachments	select	environment	spec.display_name, spec.cloud, spec.region, status.phase, page_size, page_token	Retrieve a sorted, filtered, paginated list of all private link attachments.
create_networking_v1_private_link_attachment	insert	spec		Make a request to create a private link attachment.
update_networking_v1_private_link_attachment	update	id, spec		Make a request to update a private link attachment.
delete_networking_v1_private_link_attachment	delete	environment, id		Make a request to delete a private link attachment.

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.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.cloud	array	Filter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values. (example: [GCP, AWS])
spec.display_name	array	Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-gcp-us-central1, prod-aws-useast1])
spec.region	array	Filter the results by exact match for spec.region. Pass multiple times to see results matching any of the values. (example: [us-central1, us-east-1])
status.phase	array	Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])

SELECT examples

get_networking_v1_private_link_attachment

Make a request to read a private link attachment.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.private_link_attachments
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_networking_v1_private_link_attachments

Retrieve a sorted, filtered, paginated list of all private link attachments.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.private_link_attachments
WHERE environment = '{{ environment }}' -- required
AND spec.display_name = '{{ spec.display_name }}'
AND spec.cloud = '{{ spec.cloud }}'
AND spec.region = '{{ spec.region }}'
AND status.phase = '{{ status.phase }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_networking_v1_private_link_attachment

Make a request to create a private link attachment.

INSERT INTO confluent.networking.private_link_attachments (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: private_link_attachments
props:
  - name: spec
    description: |
      The desired state of the Private Link Attachment
    value:
      display_name: "{{ display_name }}"
      cloud: "{{ cloud }}"
      region: "{{ region }}"
      environment:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
        api_version: "{{ api_version }}"
        kind: "{{ kind }}"

UPDATE examples

update_networking_v1_private_link_attachment

Make a request to update a private link attachment.

UPDATE confluent.networking.private_link_attachments
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

Make a request to delete a private link attachment.

DELETE FROM confluent.networking.private_link_attachments
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;