getByokKey

Confluent v2.59.0, Mar 6 26

Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-confluentcloud

Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-confluentcloud

Example Usage

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

const azureKey = confluentcloud.getByokKey({
    id: "cck-abcde",
});
export const byok = azureKey;

import pulumi
import pulumi_confluentcloud as confluentcloud

azure_key = confluentcloud.get_byok_key(id="cck-abcde")
pulumi.export("byok", azure_key)

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 {
		azureKey, err := confluentcloud.LookupByokKey(ctx, &confluentcloud.LookupByokKeyArgs{
			Id: "cck-abcde",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("byok", azureKey)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var azureKey = ConfluentCloud.GetByokKey.Invoke(new()
    {
        Id = "cck-abcde",
    });

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

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.GetByokKeyArgs;
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 azureKey = ConfluentcloudFunctions.getByokKey(GetByokKeyArgs.builder()
            .id("cck-abcde")
            .build());

        ctx.export("byok", azureKey);
    }
}

variables:
  azureKey:
    fn::invoke:
      function: confluentcloud:getByokKey
      arguments:
        id: cck-abcde
outputs:
  byok: ${azureKey}

Using getByokKey

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 getByokKey(args: GetByokKeyArgs, opts?: InvokeOptions): Promise<GetByokKeyResult>
function getByokKeyOutput(args: GetByokKeyOutputArgs, opts?: InvokeOptions): Output<GetByokKeyResult>

def get_byok_key(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetByokKeyResult
def get_byok_key_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetByokKeyResult]

func LookupByokKey(ctx *Context, args *LookupByokKeyArgs, opts ...InvokeOption) (*LookupByokKeyResult, error)
func LookupByokKeyOutput(ctx *Context, args *LookupByokKeyOutputArgs, opts ...InvokeOption) LookupByokKeyResultOutput

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

public static class GetByokKey 
{
    public static Task<GetByokKeyResult> InvokeAsync(GetByokKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetByokKeyResult> Invoke(GetByokKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetByokKeyResult> getByokKey(GetByokKeyArgs args, InvokeOptions options)
public static Output<GetByokKeyResult> getByokKey(GetByokKeyArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: The ID of the BYOK key, for example, cck-abcde.

Id string: The ID of the BYOK key, for example, cck-abcde.

id String: The ID of the BYOK key, for example, cck-abcde.

id string: The ID of the BYOK key, for example, cck-abcde.

id str: The ID of the BYOK key, for example, cck-abcde.

id String: The ID of the BYOK key, for example, cck-abcde.

getByokKey Result

The following output properties are available:

Aws List<Pulumi.ConfluentCloud.Outputs.GetByokKeyAw>: (Optional Configuration Block) supports the following:
Azures List<Pulumi.ConfluentCloud.Outputs.GetByokKeyAzure>: (Optional Configuration Block) supports the following:
Gcps List<Pulumi.ConfluentCloud.Outputs.GetByokKeyGcp>: (Optional Configuration Block) supports the following:
Id string: (Required String) The ID of the BYOK key, for example, cck-abcde.

Aws []GetByokKeyAw: (Optional Configuration Block) supports the following:
Azures []GetByokKeyAzure: (Optional Configuration Block) supports the following:
Gcps []GetByokKeyGcp: (Optional Configuration Block) supports the following:
Id string: (Required String) The ID of the BYOK key, for example, cck-abcde.

aws List<GetByokKeyAw>: (Optional Configuration Block) supports the following:
azures List<GetByokKeyAzure>: (Optional Configuration Block) supports the following:
gcps List<GetByokKeyGcp>: (Optional Configuration Block) supports the following:
id String: (Required String) The ID of the BYOK key, for example, cck-abcde.

aws GetByokKeyAw[]: (Optional Configuration Block) supports the following:
azures GetByokKeyAzure[]: (Optional Configuration Block) supports the following:
gcps GetByokKeyGcp[]: (Optional Configuration Block) supports the following:
id string: (Required String) The ID of the BYOK key, for example, cck-abcde.

aws Sequence[GetByokKeyAw]: (Optional Configuration Block) supports the following:
azures Sequence[GetByokKeyAzure]: (Optional Configuration Block) supports the following:
gcps Sequence[GetByokKeyGcp]: (Optional Configuration Block) supports the following:
id str: (Required String) The ID of the BYOK key, for example, cck-abcde.

aws List<Property Map>: (Optional Configuration Block) supports the following:
azures List<Property Map>: (Optional Configuration Block) supports the following:
gcps List<Property Map>: (Optional Configuration Block) supports the following:
id String: (Required String) The ID of the BYOK key, for example, cck-abcde.

Supporting Types

GetByokKeyAw

KeyArn string: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
Roles List<string>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

KeyArn string: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
Roles []string: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

keyArn String: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
roles List<String>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

keyArn string: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
roles string[]: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

key_arn str: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
roles Sequence[str]: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

keyArn String: (Required String) The Amazon Resource Name (ARN) of an AWS KMS key.
roles List<String>: (Optional List of Strings) The Amazon Resource Names (ARNs) of IAM Roles created for this key-environment combination.

GetByokKeyAzure

ApplicationId string: (Optional String) The Application ID created for this key-environment combination.
KeyIdentifier string: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
KeyVaultId string: (Required String) Key Vault ID containing the key.
TenantId string: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

ApplicationId string: (Optional String) The Application ID created for this key-environment combination.
KeyIdentifier string: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
KeyVaultId string: (Required String) Key Vault ID containing the key.
TenantId string: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

applicationId String: (Optional String) The Application ID created for this key-environment combination.
keyIdentifier String: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId String: (Required String) Key Vault ID containing the key.
tenantId String: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

applicationId string: (Optional String) The Application ID created for this key-environment combination.
keyIdentifier string: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId string: (Required String) Key Vault ID containing the key.
tenantId string: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

application_id str: (Optional String) The Application ID created for this key-environment combination.
key_identifier str: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
key_vault_id str: (Required String) Key Vault ID containing the key.
tenant_id str: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

applicationId String: (Optional String) The Application ID created for this key-environment combination.
keyIdentifier String: (Required String) The unique Key Object Identifier URL of an Azure Key Vault key.
keyVaultId String: (Required String) Key Vault ID containing the key.
tenantId String: (Required String) Tenant ID (uuid) hosting the Key Vault containing the key.

GetByokKeyGcp

KeyId string: (Required String) The Google Cloud Platform key ID.
SecurityGroup string: (Optional String) The Google security group created for this key.

KeyId string: (Required String) The Google Cloud Platform key ID.
SecurityGroup string: (Optional String) The Google security group created for this key.

keyId String: (Required String) The Google Cloud Platform key ID.
securityGroup String: (Optional String) The Google security group created for this key.

keyId string: (Required String) The Google Cloud Platform key ID.
securityGroup string: (Optional String) The Google security group created for this key.

key_id str: (Required String) The Google Cloud Platform key ID.
security_group str: (Optional String) The Google security group created for this key.

keyId String: (Required String) The Google Cloud Platform key ID.
securityGroup String: (Optional String) The Google security group created for this key.