access_points

Creates, updates, deletes, gets or lists an access_points resource.

Overview

Name	access_points
Type	Resource
Id	confluent.networking.access_points

Fields

The following fields are returned by SELECT queries:

get_networking_v1_access_point

Access Point.

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. (AccessPoint)
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 Access Point
status	object	The status of the Access Point

list_networking_v1_access_points

Access Point.

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. (AccessPoint)
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 Access Point
status	object	The status of the Access Point

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_networking_v1_access_point	select	environment, id		Make a request to read an access point.
list_networking_v1_access_points	select	environment	spec.display_name, spec.gateway, id, page_size, page_token	Retrieve a sorted, filtered, paginated list of all access points.
create_networking_v1_access_point	insert	spec		Make a request to create an access point.
update_networking_v1_access_point	update	id, spec		Make a request to update an access point.
delete_networking_v1_access_point	delete	environment, id		Make a request to delete an access point.

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 access point.
id	array	Filter the results by exact match for id. Pass multiple times to see results matching any of the values. (example: [ap-1, ap-2])
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
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-ap-egress-use1, prod-ap-egress-usw2])
spec.gateway	array	Filter the results by exact match for spec.gateway. Pass multiple times to see results matching any of the values. (example: [gw-00000, gw-00001])

SELECT examples

get_networking_v1_access_point

Make a request to read an access point.

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

list_networking_v1_access_points

Retrieve a sorted, filtered, paginated list of all access points.

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

INSERT examples

create_networking_v1_access_point

Make a request to create an access point.

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

Manifest

# Description fields are for documentation purposes
- name: access_points
props:
  - name: spec
    description: |
      The desired state of the Access Point
    value:
      display_name: "{{ display_name }}"
      config:
        kind: "{{ kind }}"
        vpc_endpoint_service_name: "{{ vpc_endpoint_service_name }}"
        enable_high_availability: {{ enable_high_availability }}
        target_system: "{{ target_system }}"
        vpc_endpoint_id: "{{ vpc_endpoint_id }}"
        private_link_service_resource_id: "{{ private_link_service_resource_id }}"
        private_link_subresource_name: "{{ private_link_subresource_name }}"
        private_endpoint_resource_id: "{{ private_endpoint_resource_id }}"
        network_interfaces:
          - "{{ network_interfaces }}"
        account: "{{ account }}"
        egress_routes:
          - "{{ egress_routes }}"
        private_service_connect_endpoint_target: "{{ private_service_connect_endpoint_target }}"
        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 }}"
      gateway:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
        api_version: "{{ api_version }}"
        kind: "{{ kind }}"

UPDATE examples

update_networking_v1_access_point

Make a request to update an access point.

UPDATE confluent.networking.access_points
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_networking_v1_access_point

Make a request to delete an access point.

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