ip_groups

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

Overview

Name	ip_groups
Type	Resource
Id	confluent.iam.ip_groups

Fields

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").
api_version	string	APIVersion defines the schema version of this representation of a resource.
cidr_blocks	array	A list of CIDRs.
group_name	string	A human readable name for an IP Group. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: [, ], \|, &, +, -, _, /, ., ,.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Methods

Name	Accessible by	Required Params	Description
get_iam_v2ip_group	SELECT	id	Make a request to read an IP group.
list_iam_v2ip_groups	SELECT		Retrieve a sorted, filtered, paginated list of all IP groups.
create_iam_v2ip_group	INSERT		Make a request to create an IP group.
delete_iam_v2ip_group	DELETE	id	Make a request to delete an IP group.
update_iam_v2ip_group	UPDATE	id	Make a request to update an IP group.

SELECT examples

Retrieve a sorted, filtered, paginated list of all IP groups.

SELECT
id,
api_version,
cidr_blocks,
group_name,
kind,
metadata
FROM confluent.iam.ip_groups
;

INSERT example

Use the following StackQL query and manifest file to create a new ip_groups resource.

All Properties

/*+ create */
INSERT INTO confluent.iam.ip_groups (
data__group_name,
data__cidr_blocks
)
SELECT 
'{{ group_name }}',
'{{ cidr_blocks }}'
;

Manifest

- name: ip_groups
  props:
    - name: group_name
      value: string
    - name: cidr_blocks
      value: array

UPDATE example

Updates a ip_groups resource.

/*+ update */
UPDATE confluent.iam.ip_groups
SET 
group_name = '{{ group_name }}',
cidr_blocks = '{{ cidr_blocks }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified ip_groups resource.

/*+ delete */
DELETE FROM confluent.iam.ip_groups
WHERE id = '{{ id }}';