1. Packages
  2. Confluent Provider
  3. API Docs
  4. getGroupMapping
Confluent v2.49.0 published on Saturday, Oct 25, 2025 by Pulumi

confluentcloud.getGroupMapping

Start a Neo task
Explain and create a confluentcloud.getGroupMapping resource
confluentcloud logo
Confluent v2.49.0 published on Saturday, Oct 25, 2025 by Pulumi

    General Availability

    confluentcloud.GroupMapping describes a Group Mapping data source.

    Note: See Group Mapping in Confluent Cloud for more details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const exampleUsingId = await confluentcloud.getGroupMapping({
            id: "group-abc123",
        });
        const exampleUsingName = await confluentcloud.getGroupMapping({
            displayName: "Default",
        });
        return {
            exampleUsingId: exampleUsingId,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example_using_id = confluentcloud.get_group_mapping(id="group-abc123")
    pulumi.export("exampleUsingId", example_using_id)
    example_using_name = confluentcloud.get_group_mapping(display_name="Default")
    
    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 {
    		exampleUsingId, err := confluentcloud.LookupGroupMapping(ctx, &confluentcloud.LookupGroupMappingArgs{
    			Id: pulumi.StringRef("group-abc123"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingId", exampleUsingId)
    		_, err = confluentcloud.LookupGroupMapping(ctx, &confluentcloud.LookupGroupMappingArgs{
    			DisplayName: pulumi.StringRef("Default"),
    		}, nil)
    		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 exampleUsingId = ConfluentCloud.GetGroupMapping.Invoke(new()
        {
            Id = "group-abc123",
        });
    
        var exampleUsingName = ConfluentCloud.GetGroupMapping.Invoke(new()
        {
            DisplayName = "Default",
        });
    
        return new Dictionary<string, object?>
        {
            ["exampleUsingId"] = exampleUsingId,
        };
    });
    
    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.GetGroupMappingArgs;
    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 exampleUsingId = ConfluentcloudFunctions.getGroupMapping(GetGroupMappingArgs.builder()
                .id("group-abc123")
                .build());
    
            ctx.export("exampleUsingId", exampleUsingId);
            final var exampleUsingName = ConfluentcloudFunctions.getGroupMapping(GetGroupMappingArgs.builder()
                .displayName("Default")
                .build());
    
        }
    }
    
    variables:
      exampleUsingId:
        fn::invoke:
          function: confluentcloud:getGroupMapping
          arguments:
            id: group-abc123
      exampleUsingName:
        fn::invoke:
          function: confluentcloud:getGroupMapping
          arguments:
            displayName: Default
    outputs:
      exampleUsingId: ${exampleUsingId}
    

    Using getGroupMapping

    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 getGroupMapping(args: GetGroupMappingArgs, opts?: InvokeOptions): Promise<GetGroupMappingResult>
    function getGroupMappingOutput(args: GetGroupMappingOutputArgs, opts?: InvokeOptions): Output<GetGroupMappingResult>
    def get_group_mapping(display_name: Optional[str] = None,
                          id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGroupMappingResult
    def get_group_mapping_output(display_name: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGroupMappingResult]
    func LookupGroupMapping(ctx *Context, args *LookupGroupMappingArgs, opts ...InvokeOption) (*LookupGroupMappingResult, error)
    func LookupGroupMappingOutput(ctx *Context, args *LookupGroupMappingOutputArgs, opts ...InvokeOption) LookupGroupMappingResultOutput

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

    public static class GetGroupMapping 
    {
        public static Task<GetGroupMappingResult> InvokeAsync(GetGroupMappingArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupMappingResult> Invoke(GetGroupMappingInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGroupMappingResult> getGroupMapping(GetGroupMappingArgs args, InvokeOptions options)
    public static Output<GetGroupMappingResult> getGroupMapping(GetGroupMappingArgs args, InvokeOptions options)
    
    fn::invoke:
      function: confluentcloud:index/getGroupMapping:getGroupMapping
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DisplayName string

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string
    The ID of the Group Mapping.
    DisplayName string

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string
    The ID of the Group Mapping.
    displayName String

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String
    The ID of the Group Mapping.
    displayName string

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    id string
    The ID of the Group Mapping.
    display_name str

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    id str
    The ID of the Group Mapping.
    displayName String

    The name of the Group Mapping.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String
    The ID of the Group Mapping.

    getGroupMapping Result

    The following output properties are available:

    Description string
    (Required String) A description explaining the purpose and use of the group mapping.
    DisplayName string
    (Required String) The name of the Group Mapping.
    Filter string
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    Id string
    (Required String) The ID of the Group Mapping (for example, group-abc123).
    Description string
    (Required String) A description explaining the purpose and use of the group mapping.
    DisplayName string
    (Required String) The name of the Group Mapping.
    Filter string
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    Id string
    (Required String) The ID of the Group Mapping (for example, group-abc123).
    description String
    (Required String) A description explaining the purpose and use of the group mapping.
    displayName String
    (Required String) The name of the Group Mapping.
    filter String
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    id String
    (Required String) The ID of the Group Mapping (for example, group-abc123).
    description string
    (Required String) A description explaining the purpose and use of the group mapping.
    displayName string
    (Required String) The name of the Group Mapping.
    filter string
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    id string
    (Required String) The ID of the Group Mapping (for example, group-abc123).
    description str
    (Required String) A description explaining the purpose and use of the group mapping.
    display_name str
    (Required String) The name of the Group Mapping.
    filter str
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    id str
    (Required String) The ID of the Group Mapping (for example, group-abc123).
    description String
    (Required String) A description explaining the purpose and use of the group mapping.
    displayName String
    (Required String) The name of the Group Mapping.
    filter String
    (Required String) A single group identifier or a condition based on supported CEL operators that defines which groups are included.
    id String
    (Required String) The ID of the Group Mapping (for example, group-abc123).

    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.49.0 published on Saturday, Oct 25, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate