confluentcloud.getGroupMapping
Explore with Pulumi AI
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/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.applyValue(getGroupMappingResult -> getGroupMappingResult));
        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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: confluentcloud:index/getGroupMapping:getGroupMapping
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Display
Name string The name of the Group Mapping.
Note: Exactly one from the
idanddisplay_nameattributes must be specified.- Id string
 - The ID of the Group Mapping.
 
- Display
Name string The name of the Group Mapping.
Note: Exactly one from the
idanddisplay_nameattributes must be specified.- Id string
 - The ID of the Group Mapping.
 
- display
Name String The name of the Group Mapping.
Note: Exactly one from the
idanddisplay_nameattributes must be specified.- id String
 - The ID of the Group Mapping.
 
- display
Name string The name of the Group Mapping.
Note: Exactly one from the
idanddisplay_nameattributes 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
idanddisplay_nameattributes must be specified.- id str
 - The ID of the Group Mapping.
 
- display
Name String The name of the Group Mapping.
Note: Exactly one from the
idanddisplay_nameattributes 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.
 - Display
Name 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.
 - Display
Name 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.
 - display
Name 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.
 - display
Name 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.
 - display
Name 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 
confluentTerraform Provider.