confluentcloud.getIpFilter

Explore with Pulumi AI

Confluent v2.37.0 published on Saturday, Sep 6, 2025 by Pulumi

Example Usage

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

export = async () => {
    const example = await confluentcloud.getIpFilter({
        id: "ipf-abc123",
    });
    return {
        example: example,
    };
}

import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_ip_filter(id="ipf-abc123")
pulumi.export("example", example)

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 {
		example, err := confluentcloud.LookupIpFilter(ctx, &confluentcloud.LookupIpFilterArgs{
			Id: "ipf-abc123",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("example", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = ConfluentCloud.GetIpFilter.Invoke(new()
    {
        Id = "ipf-abc123",
    });

    return new Dictionary<string, object?>
    {
        ["example"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetIpFilterArgs;
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) {
        final var example = ConfluentcloudFunctions.getIpFilter(GetIpFilterArgs.builder()
            .id("ipf-abc123")
            .build());

        ctx.export("example", example);
    }
}

variables:
  example:
    fn::invoke:
      function: confluentcloud:getIpFilter
      arguments:
        id: ipf-abc123
outputs:
  example: ${example}

Using getIpFilter

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIpFilter(args: GetIpFilterArgs, opts?: InvokeOptions): Promise<GetIpFilterResult>
function getIpFilterOutput(args: GetIpFilterOutputArgs, opts?: InvokeOptions): Output<GetIpFilterResult>

def get_ip_filter(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIpFilterResult
def get_ip_filter_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetIpFilterResult]

func LookupIpFilter(ctx *Context, args *LookupIpFilterArgs, opts ...InvokeOption) (*LookupIpFilterResult, error)
func LookupIpFilterOutput(ctx *Context, args *LookupIpFilterOutputArgs, opts ...InvokeOption) LookupIpFilterResultOutput

> Note: This function is named LookupIpFilter in the Go SDK.

public static class GetIpFilter 
{
    public static Task<GetIpFilterResult> InvokeAsync(GetIpFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetIpFilterResult> Invoke(GetIpFilterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpFilterResult> getIpFilter(GetIpFilterArgs args, InvokeOptions options)
public static Output<GetIpFilterResult> getIpFilter(GetIpFilterArgs args, InvokeOptions options)

fn::invoke:
  function: confluentcloud:index/getIpFilter:getIpFilter
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the IP Group (e.g., ipf-abc123).

Id string: The ID of the IP Group (e.g., ipf-abc123).

id String: The ID of the IP Group (e.g., ipf-abc123).

id string: The ID of the IP Group (e.g., ipf-abc123).

id str: The ID of the IP Group (e.g., ipf-abc123).

id String: The ID of the IP Group (e.g., ipf-abc123).

getIpFilter Result

The following output properties are available:

FilterName string: (Required 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: [, ], |, &, +, -, _, /, ., ,.
Id string
IpGroups List<string>: (Required List of Strings) A list of IP Groups.
OperationGroups List<string>: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
ResourceScope string: (Required 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: (Required 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: [, ], |, &, +, -, _, /, ., ,.
Id string
IpGroups []string: (Required List of Strings) A list of IP Groups.
OperationGroups []string: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
ResourceScope string: (Required 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: (Required 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: [, ], |, &, +, -, _, /, ., ,.
id String
ipGroups List<String>: (Required List of Strings) A list of IP Groups.
operationGroups List<String>: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
resourceScope String: (Required 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: (Required 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: [, ], |, &, +, -, _, /, ., ,.
id string
ipGroups string[]: (Required List of Strings) A list of IP Groups.
operationGroups string[]: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
resourceScope string: (Required 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: (Required 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: [, ], |, &, +, -, _, /, ., ,.
id str
ip_groups Sequence[str]: (Required List of Strings) A list of IP Groups.
operation_groups Sequence[str]: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
resource_scope str: (Required 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: (Required 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: [, ], |, &, +, -, _, /, ., ,.
id String
ipGroups List<String>: (Required List of Strings) A list of IP Groups.
operationGroups List<String>: (Required List of Strings) 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: (Required String) Scope of resources covered by this IP Filter. Available resource groups include "management" and "multiple".
resourceScope String: (Required 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.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.

Confluent v2.37.0 published on Saturday, Sep 6, 2025 by Pulumi

pulumi/pulumi-confluentcloud

confluentcloud.getIpFilter

On this page

On this page

Example Usage

Using getIpFilter

getIpFilter Result

Package Details

On this page

On this page