ip_groups

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

Overview

Name	ip_groups
Type	Resource
Id	confluent.iam.ip_groups

Fields

The following fields are returned by SELECT queries:

get_iam_v2_ip_group

IP Group.

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)
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: [, ], |, &, +, -, _, /, ., ,. (example: CorpNet)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
cidr_blocks	array	A list of CIDRs.
kind	string	Kind defines the object this REST resource represents. (IpGroup)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

list_iam_v2_ip_groups

IP Group.

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)
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: [, ], |, &, +, -, _, /, ., ,. (example: CorpNet)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
cidr_blocks	array	A list of CIDRs.
kind	string	Kind defines the object this REST resource represents. (IpGroup)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_iam_v2_ip_group	select	id		Make a request to read an IP group.
list_iam_v2_ip_groups	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all IP groups.
create_iam_v2_ip_group	insert	group_name, cidr_blocks		Make a request to create an IP group.
update_iam_v2_ip_group	update	id		Make a request to update an IP group.
delete_iam_v2_ip_group	delete	id		Make a request to delete an IP group.

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
id	string	The unique identifier for the IP group.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_iam_v2_ip_group

Make a request to read an IP group.

SELECT
id,
group_name,
api_version,
cidr_blocks,
kind,
metadata
FROM confluent.iam.ip_groups
WHERE id = '{{ id }}' -- required
;

list_iam_v2_ip_groups

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

SELECT
id,
group_name,
api_version,
cidr_blocks,
kind,
metadata
FROM confluent.iam.ip_groups
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_iam_v2_ip_group

Make a request to create an IP group.

INSERT INTO confluent.iam.ip_groups (
group_name,
cidr_blocks
)
SELECT 
'{{ group_name }}' /* required */,
'{{ cidr_blocks }}' /* required */
RETURNING
id,
group_name,
api_version,
cidr_blocks,
kind,
metadata
;

Manifest

# Description fields are for documentation purposes
- name: ip_groups
props:
  - name: group_name
    value: "{{ group_name }}"
    description: |
      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: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
  - name: cidr_blocks
    value:
      - "{{ cidr_blocks }}"
    description: |
      A list of CIDRs.

UPDATE examples

update_iam_v2_ip_group

Make a request to update an IP group.

UPDATE confluent.iam.ip_groups
SET 
group_name = '{{ group_name }}',
cidr_blocks = '{{ cidr_blocks }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
group_name,
api_version,
cidr_blocks,
kind,
metadata;

DELETE examples

delete_iam_v2_ip_group

Make a request to delete an IP group.

DELETE FROM confluent.iam.ip_groups
WHERE id = '{{ id }}' --required
;