ip_filters

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

Overview

Name	ip_filters
Type	Resource
Id	confluent.iam.ip_filters

Fields

The following fields are returned by SELECT queries:

get_iam_v2_ip_filter

IP Filter.

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)
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: [, ], |, &, +, -, _, /, ., ,. (example: Management API Rules)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
ip_groups	array	A list of IP Groups.
kind	string	Kind defines the object this REST resource represents. (IpFilter)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
operation_groups	array	Scope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).
resource_group	string	Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". (example: management)
resource_scope	string (uri)	A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization. (example: crn://confluent.cloud/organization=org-123/environment=env-abc, pattern: ^crn://.+$)

list_iam_v2_ip_filters

IP Filter.

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)
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: [, ], |, &, +, -, _, /, ., ,. (example: Management API Rules)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
ip_groups	array	A list of IP Groups.
kind	string	Kind defines the object this REST resource represents. (IpFilter)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
operation_groups	array	Scope of resources covered by this IP filter. Resource group must be set to 'multiple' in order to use this property.During update operations, note that the operation groups passed in will replace the list of existing operation groups (passing in an empty list will remove all operation groups) from the filter (in line with the behavior for ip_groups).
resource_group	string	Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple". (example: management)
resource_scope	string (uri)	A CRN that specifies the scope of the ip filter, specifically the organization or environment. Without specifying this property, the ip filter would apply to the whole organization. (example: crn://confluent.cloud/organization=org-123/environment=env-abc, pattern: ^crn://.+$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_iam_v2_ip_filter	select	id		Make a request to read an IP filter.
list_iam_v2_ip_filters	select		resource_scope, include_parent_scopes, page_size, page_token	Retrieve a sorted, filtered, paginated list of all IP filters.
create_iam_v2_ip_filter	insert	filter_name, resource_group, ip_groups		Make a request to create an IP filter.
update_iam_v2_ip_filter	update	id		Make a request to update an IP filter.
delete_iam_v2_ip_filter	delete	id		Make a request to delete an IP filter.

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 filter.
include_parent_scopes	string	If set to true, this includes filters defined at the organization level. The resource scope must also be set to use this parameter.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
resource_scope	string	Lists all filters belonging to the specified resource scope.

SELECT examples

get_iam_v2_ip_filter

Make a request to read an IP filter.

SELECT
id,
filter_name,
api_version,
ip_groups,
kind,
metadata,
operation_groups,
resource_group,
resource_scope
FROM confluent.iam.ip_filters
WHERE id = '{{ id }}' -- required
;

list_iam_v2_ip_filters

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

SELECT
id,
filter_name,
api_version,
ip_groups,
kind,
metadata,
operation_groups,
resource_group,
resource_scope
FROM confluent.iam.ip_filters
WHERE resource_scope = '{{ resource_scope }}'
AND include_parent_scopes = '{{ include_parent_scopes }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_iam_v2_ip_filter

Make a request to create an IP filter.

INSERT INTO confluent.iam.ip_filters (
filter_name,
resource_group,
resource_scope,
operation_groups,
ip_groups
)
SELECT 
'{{ filter_name }}' /* required */,
'{{ resource_group }}' /* required */,
'{{ resource_scope }}',
'{{ operation_groups }}',
'{{ ip_groups }}' /* required */
RETURNING
id,
filter_name,
api_version,
ip_groups,
kind,
metadata,
operation_groups,
resource_group,
resource_scope
;

Manifest

# Description fields are for documentation purposes
- name: ip_filters
props:
  - name: filter_name
    value: "{{ filter_name }}"
    description: |
      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: `[`, `]`, `|`, `&`, `+`, `-`, `_`, `/`, `.`, `,`.
  - name: resource_group
    value: "{{ resource_group }}"
    description: |
      Scope of resources covered by this IP filter. Available resource groups include "management" and "multiple".
  - name: resource_scope
    value: "{{ resource_scope }}"
    description: |
      A CRN that specifies the scope of the ip filter, specifically the organization
      or environment. Without specifying this property, the ip filter
      would apply to the whole organization.
  - name: operation_groups
    value:
      - "{{ operation_groups }}"
    description: |
      Scope of resources covered by this IP filter. Resource group must be set to 'multiple'
      in order to use this property.During update operations, note that the operation
      groups passed in will replace the list of existing operation groups
      (passing in an empty list will remove all operation groups) from the filter
      (in line with the behavior for ip_groups).
  - name: ip_groups
    description: |
      A list of IP Groups.
    value:
      - id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_iam_v2_ip_filter

Make a request to update an IP filter.

UPDATE confluent.iam.ip_filters
SET 
filter_name = '{{ filter_name }}',
resource_group = '{{ resource_group }}',
resource_scope = '{{ resource_scope }}',
operation_groups = '{{ operation_groups }}',
ip_groups = '{{ ip_groups }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
filter_name,
api_version,
ip_groups,
kind,
metadata,
operation_groups,
resource_group,
resource_scope;

DELETE examples

delete_iam_v2_ip_filter

Make a request to delete an IP filter.

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