1. Packages
  2. Confluent Provider
  3. API Docs
  4. getIpGroup
Confluent v2.37.0 published on Saturday, Sep 6, 2025 by Pulumi

confluentcloud.getIpGroup

Explore with Pulumi AI

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

    General Availability

    confluentcloud.IpGroup describes an IP Group data source.

    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";
    
    export = async () => {
        const example = await confluentcloud.getIpGroup({
            id: "ipg-abc123",
        });
        return {
            example: example,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example = confluentcloud.get_ip_group(id="ipg-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.LookupIpGroup(ctx, &confluentcloud.LookupIpGroupArgs{
    			Id: "ipg-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.GetIpGroup.Invoke(new()
        {
            Id = "ipg-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.GetIpGroupArgs;
    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.getIpGroup(GetIpGroupArgs.builder()
                .id("ipg-abc123")
                .build());
    
            ctx.export("example", example);
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: confluentcloud:getIpGroup
          arguments:
            id: ipg-abc123
    outputs:
      example: ${example}
    

    Using getIpGroup

    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 getIpGroup(args: GetIpGroupArgs, opts?: InvokeOptions): Promise<GetIpGroupResult>
    function getIpGroupOutput(args: GetIpGroupOutputArgs, opts?: InvokeOptions): Output<GetIpGroupResult>
    def get_ip_group(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetIpGroupResult
    def get_ip_group_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetIpGroupResult]
    func LookupIpGroup(ctx *Context, args *LookupIpGroupArgs, opts ...InvokeOption) (*LookupIpGroupResult, error)
    func LookupIpGroupOutput(ctx *Context, args *LookupIpGroupOutputArgs, opts ...InvokeOption) LookupIpGroupResultOutput

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

    public static class GetIpGroup 
    {
        public static Task<GetIpGroupResult> InvokeAsync(GetIpGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetIpGroupResult> Invoke(GetIpGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpGroupResult> getIpGroup(GetIpGroupArgs args, InvokeOptions options)
    public static Output<GetIpGroupResult> getIpGroup(GetIpGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: confluentcloud:index/getIpGroup:getIpGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the IP Group (e.g., ipg-abc123).
    Id string
    The ID of the IP Group (e.g., ipg-abc123).
    id String
    The ID of the IP Group (e.g., ipg-abc123).
    id string
    The ID of the IP Group (e.g., ipg-abc123).
    id str
    The ID of the IP Group (e.g., ipg-abc123).
    id String
    The ID of the IP Group (e.g., ipg-abc123).

    getIpGroup Result

    The following output properties are available:

    CidrBlocks List<string>
    (Required List of Strings) A list of CIDRs.
    GroupName string
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    Id string
    CidrBlocks []string
    (Required List of Strings) A list of CIDRs.
    GroupName string
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    Id string
    cidrBlocks List<String>
    (Required List of Strings) A list of CIDRs.
    groupName String
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    id String
    cidrBlocks string[]
    (Required List of Strings) A list of CIDRs.
    groupName string
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    id string
    cidr_blocks Sequence[str]
    (Required List of Strings) A list of CIDRs.
    group_name str
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    id str
    cidrBlocks List<String>
    (Required List of Strings) A list of CIDRs.
    groupName String
    (Required 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: [, ], |, &, +, -, _, /, ., ,.
    id String

    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.37.0 published on Saturday, Sep 6, 2025 by Pulumi