Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getIdentityPool
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getIdentityPool

Explore with Pulumi AI

confluentcloud logo
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.IdentityPool describes an Identity Pool data source.

    Example Usage

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

export = async () => {
    const exampleUsingId = await confluentcloud.getIdentityPool({
        id: "pool-xyz456",
        identityProvider: {
            id: "op-abc123",
        },
    });
    const exampleUsingName = await confluentcloud.getIdentityPool({
        displayName: "My Identity Pool",
        identityProvider: {
            id: "op-abc123",
        },
    });
    return {
        exampleUsingId: exampleUsingId,
        exampleUsingName: exampleUsingName,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example_using_id = confluentcloud.get_identity_pool(id="pool-xyz456",
    identity_provider={
        "id": "op-abc123",
    })
pulumi.export("exampleUsingId", example_using_id)
example_using_name = confluentcloud.get_identity_pool(display_name="My Identity Pool",
    identity_provider={
        "id": "op-abc123",
    })
pulumi.export("exampleUsingName", example_using_name)

    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.LookupIdentityPool(ctx, &confluentcloud.LookupIdentityPoolArgs{
			Id: pulumi.StringRef("pool-xyz456"),
			IdentityProvider: confluentcloud.GetIdentityPoolIdentityProvider{
				Id: "op-abc123",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingId", exampleUsingId)
		exampleUsingName, err := confluentcloud.LookupIdentityPool(ctx, &confluentcloud.LookupIdentityPoolArgs{
			DisplayName: pulumi.StringRef("My Identity Pool"),
			IdentityProvider: confluentcloud.GetIdentityPoolIdentityProvider{
				Id: "op-abc123",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingName)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleUsingId = ConfluentCloud.GetIdentityPool.Invoke(new()
    {
        Id = "pool-xyz456",
        IdentityProvider = new ConfluentCloud.Inputs.GetIdentityPoolIdentityProviderInputArgs
        {
            Id = "op-abc123",
        },
    });

    var exampleUsingName = ConfluentCloud.GetIdentityPool.Invoke(new()
    {
        DisplayName = "My Identity Pool",
        IdentityProvider = new ConfluentCloud.Inputs.GetIdentityPoolIdentityProviderInputArgs
        {
            Id = "op-abc123",
        },
    });

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

    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.GetIdentityPoolArgs;
import com.pulumi.confluentcloud.inputs.GetIdentityPoolIdentityProviderArgs;
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.getIdentityPool(GetIdentityPoolArgs.builder()
            .id("pool-xyz456")
            .identityProvider(GetIdentityPoolIdentityProviderArgs.builder()
                .id("op-abc123")
                .build())
            .build());

        ctx.export("exampleUsingId", exampleUsingId.applyValue(getIdentityPoolResult -> getIdentityPoolResult));
        final var exampleUsingName = ConfluentcloudFunctions.getIdentityPool(GetIdentityPoolArgs.builder()
            .displayName("My Identity Pool")
            .identityProvider(GetIdentityPoolIdentityProviderArgs.builder()
                .id("op-abc123")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingName.applyValue(getIdentityPoolResult -> getIdentityPoolResult));
    }
}

    variables:
  exampleUsingId:
    fn::invoke:
      Function: confluentcloud:getIdentityPool
      Arguments:
        id: pool-xyz456
        identityProvider:
          id: op-abc123
  exampleUsingName:
    fn::invoke:
      Function: confluentcloud:getIdentityPool
      Arguments:
        displayName: My Identity Pool
        identityProvider:
          id: op-abc123
outputs:
  exampleUsingId: ${exampleUsingId}
  exampleUsingName: ${exampleUsingName}

    Using getIdentityPool

    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 getIdentityPool(args: GetIdentityPoolArgs, opts?: InvokeOptions): Promise<GetIdentityPoolResult>
function getIdentityPoolOutput(args: GetIdentityPoolOutputArgs, opts?: InvokeOptions): Output<GetIdentityPoolResult>
    def get_identity_pool(display_name: Optional[str] = None,
                      id: Optional[str] = None,
                      identity_provider: Optional[GetIdentityPoolIdentityProvider] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIdentityPoolResult
def get_identity_pool_output(display_name: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      identity_provider: Optional[pulumi.Input[GetIdentityPoolIdentityProviderArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIdentityPoolResult]
    func LookupIdentityPool(ctx *Context, args *LookupIdentityPoolArgs, opts ...InvokeOption) (*LookupIdentityPoolResult, error)
func LookupIdentityPoolOutput(ctx *Context, args *LookupIdentityPoolOutputArgs, opts ...InvokeOption) LookupIdentityPoolResultOutput

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

    public static class GetIdentityPool 
{
    public static Task<GetIdentityPoolResult> InvokeAsync(GetIdentityPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityPoolResult> Invoke(GetIdentityPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIdentityPoolResult> getIdentityPool(GetIdentityPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    IdentityProvider Pulumi.ConfluentCloud.Inputs.GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Identity Pool.
    Id string
    The ID of the Identity Pool, for example, pool-xyz456.
    IdentityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Identity Pool.
    Id string
    The ID of the Identity Pool, for example, pool-xyz456.
    identityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Identity Pool.
    id String
    The ID of the Identity Pool, for example, pool-xyz456.
    identityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    displayName string
    A human-readable name for the Identity Pool.
    id string
    The ID of the Identity Pool, for example, pool-xyz456.
    identity_provider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    display_name str
    A human-readable name for the Identity Pool.
    id str
    The ID of the Identity Pool, for example, pool-xyz456.
    identityProvider Property Map
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Identity Pool.
    id String
    The ID of the Identity Pool, for example, pool-xyz456.

    getIdentityPool Result

    The following output properties are available:

    Description string
    (Required String) A description for the Identity Pool.
    DisplayName string
    (Required String) A human-readable name for the Identity Pool.
    Filter string
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    Id string
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    IdentityClaim string
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    IdentityProvider Pulumi.ConfluentCloud.Outputs.GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    Description string
    (Required String) A description for the Identity Pool.
    DisplayName string
    (Required String) A human-readable name for the Identity Pool.
    Filter string
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    Id string
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    IdentityClaim string
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    IdentityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    description String
    (Required String) A description for the Identity Pool.
    displayName String
    (Required String) A human-readable name for the Identity Pool.
    filter String
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    id String
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    identityClaim String
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    identityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    description string
    (Required String) A description for the Identity Pool.
    displayName string
    (Required String) A human-readable name for the Identity Pool.
    filter string
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    id string
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    identityClaim string
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    identityProvider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    description str
    (Required String) A description for the Identity Pool.
    display_name str
    (Required String) A human-readable name for the Identity Pool.
    filter str
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    id str
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    identity_claim str
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    identity_provider GetIdentityPoolIdentityProvider
    (Required Configuration Block) supports the following:
    description String
    (Required String) A description for the Identity Pool.
    displayName String
    (Required String) A human-readable name for the Identity Pool.
    filter String
    (Required String) A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
    id String
    (Required String) The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.
    identityClaim String
    (Required String) The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
    identityProvider Property Map
    (Required Configuration Block) supports the following:

    Supporting Types

    GetIdentityPoolIdentityProvider

    Id string

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    Id string

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    id String

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    id string

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    id str

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    id String

    The ID of the Identity Provider associated with the Identity Pool, for example, op-abc123.

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

    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.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-confluentcloud