Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. IpFilter
Confluent v2.34.0 published on Saturday, Aug 2, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.IpFilter

Explore with Pulumi AI

confluentcloud logo
Confluent v2.34.0 published on Saturday, Aug 2, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.IpFilter provides an IP Filter resource that enables creating, editing, and deleting IP Filters on Confluent Cloud.

    Note: See IP Filtering on Confluent Cloud for more details about the IP Filtering feature, its prerequisites, and its limitations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

const management_filter = new confluentcloud.IpFilter("management-filter", {
    filterName: "Management API Rules",
    resourceGroup: "management",
    ipGroups: [example.id],
});
const multiple_filter = new confluentcloud.IpFilter("multiple-filter", {
    filterName: "Management, Schema, Flink API Rules",
    resourceGroup: "multiple",
    operationGroups: [
        "MANAGEMENT",
        "SCHEMA",
        "FLINK",
    ],
    ipGroups: [example.id],
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

management_filter = confluentcloud.IpFilter("management-filter",
    filter_name="Management API Rules",
    resource_group="management",
    ip_groups=[example["id"]])
multiple_filter = confluentcloud.IpFilter("multiple-filter",
    filter_name="Management, Schema, Flink API Rules",
    resource_group="multiple",
    operation_groups=[
        "MANAGEMENT",
        "SCHEMA",
        "FLINK",
    ],
    ip_groups=[example["id"]])

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluentcloud.NewIpFilter(ctx, "management-filter", &confluentcloud.IpFilterArgs{
			FilterName:    pulumi.String("Management API Rules"),
			ResourceGroup: pulumi.String("management"),
			IpGroups: pulumi.StringArray{
				example.Id,
			},
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewIpFilter(ctx, "multiple-filter", &confluentcloud.IpFilterArgs{
			FilterName:    pulumi.String("Management, Schema, Flink API Rules"),
			ResourceGroup: pulumi.String("multiple"),
			OperationGroups: pulumi.StringArray{
				pulumi.String("MANAGEMENT"),
				pulumi.String("SCHEMA"),
				pulumi.String("FLINK"),
			},
			IpGroups: pulumi.StringArray{
				example.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var management_filter = new ConfluentCloud.IpFilter("management-filter", new()
    {
        FilterName = "Management API Rules",
        ResourceGroup = "management",
        IpGroups = new[]
        {
            example.Id,
        },
    });

    var multiple_filter = new ConfluentCloud.IpFilter("multiple-filter", new()
    {
        FilterName = "Management, Schema, Flink API Rules",
        ResourceGroup = "multiple",
        OperationGroups = new[]
        {
            "MANAGEMENT",
            "SCHEMA",
            "FLINK",
        },
        IpGroups = new[]
        {
            example.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.IpFilter;
import com.pulumi.confluentcloud.IpFilterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var management_filter = new IpFilter("management-filter", IpFilterArgs.builder()
            .filterName("Management API Rules")
            .resourceGroup("management")
            .ipGroups(example.id())
            .build());

        var multiple_filter = new IpFilter("multiple-filter", IpFilterArgs.builder()
            .filterName("Management, Schema, Flink API Rules")
            .resourceGroup("multiple")
            .operationGroups(            
                "MANAGEMENT",
                "SCHEMA",
                "FLINK")
            .ipGroups(example.id())
            .build());

    }
}

    resources:
  management-filter:
    type: confluentcloud:IpFilter
    properties:
      filterName: Management API Rules
      resourceGroup: management
      ipGroups:
        - ${example.id}
  multiple-filter:
    type: confluentcloud:IpFilter
    properties:
      filterName: Management, Schema, Flink API Rules
      resourceGroup: multiple
      operationGroups:
        - MANAGEMENT
        - SCHEMA
        - FLINK
      ipGroups:
        - ${example.id}

    Create IpFilter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IpFilter(name: string, args: IpFilterArgs, opts?: CustomResourceOptions);
    @overload
def IpFilter(resource_name: str,
             args: IpFilterArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def IpFilter(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             filter_name: Optional[str] = None,
             ip_groups: Optional[Sequence[str]] = None,
             resource_group: Optional[str] = None,
             operation_groups: Optional[Sequence[str]] = None,
             resource_scope: Optional[str] = None)
    func NewIpFilter(ctx *Context, name string, args IpFilterArgs, opts ...ResourceOption) (*IpFilter, error)
    public IpFilter(string name, IpFilterArgs args, CustomResourceOptions? opts = null)
    public IpFilter(String name, IpFilterArgs args)
public IpFilter(String name, IpFilterArgs args, CustomResourceOptions options)

    type: confluentcloud:IpFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IpFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IpFilterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IpFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpFilterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ipFilterResource = new ConfluentCloud.IpFilter("ipFilterResource", new()
{
    FilterName = "string",
    IpGroups = new[]
    {
        "string",
    },
    ResourceGroup = "string",
    OperationGroups = new[]
    {
        "string",
    },
    ResourceScope = "string",
});

    example, err := confluentcloud.NewIpFilter(ctx, "ipFilterResource", &confluentcloud.IpFilterArgs{
	FilterName: pulumi.String("string"),
	IpGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResourceGroup: pulumi.String("string"),
	OperationGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResourceScope: pulumi.String("string"),
})

    var ipFilterResource = new IpFilter("ipFilterResource", IpFilterArgs.builder()
    .filterName("string")
    .ipGroups("string")
    .resourceGroup("string")
    .operationGroups("string")
    .resourceScope("string")
    .build());

    ip_filter_resource = confluentcloud.IpFilter("ipFilterResource",
    filter_name="string",
    ip_groups=["string"],
    resource_group="string",
    operation_groups=["string"],
    resource_scope="string")

    const ipFilterResource = new confluentcloud.IpFilter("ipFilterResource", {
    filterName: "string",
    ipGroups: ["string"],
    resourceGroup: "string",
    operationGroups: ["string"],
    resourceScope: "string",
});

    type: confluentcloud:IpFilter
properties:
    filterName: string
    ipGroups:
        - string
    operationGroups:
        - string
    resourceGroup: string
    resourceScope: string

    IpFilter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IpFilter resource accepts the following input properties:

    FilterName 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: [, ], |, &, +, -, _, /, ., ,.
    IpGroups List<string>
    A list of IP Groups.
    ResourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    OperationGroups List<string>
    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 attribute).
    ResourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    FilterName 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: [, ], |, &, +, -, _, /, ., ,.
    IpGroups []string
    A list of IP Groups.
    ResourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    OperationGroups []string
    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 attribute).
    ResourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups List<String>
    A list of IP Groups.
    resourceGroup String
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    operationGroups List<String>
    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 attribute).
    resourceScope String
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups string[]
    A list of IP Groups.
    resourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    operationGroups string[]
    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 attribute).
    resourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filter_name str
    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 Sequence[str]
    A list of IP Groups.
    resource_group str
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    operation_groups Sequence[str]
    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 attribute).
    resource_scope str
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups List<String>
    A list of IP Groups.
    resourceGroup String
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    operationGroups List<String>
    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 attribute).
    resourceScope String
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpFilter resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IpFilter Resource

    Get an existing IpFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IpFilterState, opts?: CustomResourceOptions): IpFilter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filter_name: Optional[str] = None,
        ip_groups: Optional[Sequence[str]] = None,
        operation_groups: Optional[Sequence[str]] = None,
        resource_group: Optional[str] = None,
        resource_scope: Optional[str] = None) -> IpFilter
    func GetIpFilter(ctx *Context, name string, id IDInput, state *IpFilterState, opts ...ResourceOption) (*IpFilter, error)
    public static IpFilter Get(string name, Input<string> id, IpFilterState? state, CustomResourceOptions? opts = null)
    public static IpFilter get(String name, Output<String> id, IpFilterState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:IpFilter    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FilterName 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: [, ], |, &, +, -, _, /, ., ,.
    IpGroups List<string>
    A list of IP Groups.
    OperationGroups List<string>
    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 attribute).
    ResourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    ResourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    FilterName 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: [, ], |, &, +, -, _, /, ., ,.
    IpGroups []string
    A list of IP Groups.
    OperationGroups []string
    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 attribute).
    ResourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    ResourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups List<String>
    A list of IP Groups.
    operationGroups List<String>
    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 attribute).
    resourceGroup String
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    resourceScope String
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups string[]
    A list of IP Groups.
    operationGroups string[]
    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 attribute).
    resourceGroup string
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    resourceScope string
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filter_name str
    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 Sequence[str]
    A list of IP Groups.
    operation_groups Sequence[str]
    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 attribute).
    resource_group str
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    resource_scope str
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.
    filterName 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: [, ], |, &, +, -, _, /, ., ,.
    ipGroups List<String>
    A list of IP Groups.
    operationGroups List<String>
    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 attribute).
    resourceGroup String
    Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
    resourceScope String
    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. For example, "crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa" or data.confluent_organization.resource_name.

    Import

    You can import an IP Filter by using IP Filter ID, for example:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/ipFilter:IpFilter example ipf-abc123

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.34.0 published on Saturday, Aug 2, 2025 by Pulumi
    pulumi/pulumi-confluentcloud