ip_filters

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

Overview

Name	ip_filters
Type	Resource
Id	confluent.iam.ip_filters

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.
filter_name	string	A human readable name for an IP Filter. Can contain any unicode letter or number, the ASCII space character, or any of the following special characters: [, ], \|, &, +, -, _, /, ., ,.
ip_groups	array	A list of IP Groups.
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.
resource_group	string	Scope of resources covered by this IP filter. The only resource_group currently available is "management".

Methods

Name	Accessible by	Required Params	Description
get_iam_v2ip_filter	SELECT	id	Make a request to read an IP filter.
list_iam_v2ip_filters	SELECT		Retrieve a sorted, filtered, paginated list of all IP filters.
create_iam_v2ip_filter	INSERT		Make a request to create an IP filter.
delete_iam_v2ip_filter	DELETE	id	Make a request to delete an IP filter.
update_iam_v2ip_filter	UPDATE	id	Make a request to update an IP filter.

SELECT examples

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

SELECT
id,
api_version,
filter_name,
ip_groups,
kind,
metadata,
resource_group
FROM confluent.iam.ip_filters
;

INSERT example

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

All Properties

/*+ create */
INSERT INTO confluent.iam.ip_filters (
data__filter_name,
data__resource_group,
data__ip_groups
)
SELECT 
'{{ filter_name }}',
'{{ resource_group }}',
'{{ ip_groups }}'
;

Manifest

- name: ip_filters
  props:
    - name: filter_name
      value: string
    - name: resource_group
      value: string
    - name: ip_groups
      value: array
      props:
        - name: id
          value: string

UPDATE example

Updates a ip_filters resource.

/*+ update */
UPDATE confluent.iam.ip_filters
SET 
filter_name = '{{ filter_name }}',
resource_group = '{{ resource_group }}',
ip_groups = '{{ ip_groups }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified ip_filters resource.

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