Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. ApiKey
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.ApiKey

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

Example Usage

Example Kafka API Key

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceArgs;
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) {
        var app_manager_kafka_api_key = new ApiKey("app-manager-kafka-api-key", ApiKeyArgs.builder()
            .displayName("app-manager-kafka-api-key")
            .description("Kafka API Key that is owned by 'app-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(app_manager.id())
                .apiVersion(app_manager.apiVersion())
                .kind(app_manager.kind())
                .build())
            .managedResource(ApiKeyManagedResourceArgs.builder()
                .id(basic.id())
                .apiVersion(basic.apiVersion())
                .kind(basic.kind())
                .environments(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

    }
}
Copy
resources:
  app-manager-kafka-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: app-manager-kafka-api-key
      description: Kafka API Key that is owned by 'app-manager' service account
      owner:
        id: ${["app-manager"].id}
        apiVersion: ${["app-manager"].apiVersion}
        kind: ${["app-manager"].kind}
      managedResource:
        id: ${basic.id}
        apiVersion: ${basic.apiVersion}
        kind: ${basic.kind}
        environments:
          - id: ${staging.id}
Copy

Example ksqlDB API Key

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceArgs;
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) {
        var ksqldb_api_key = new ApiKey("ksqldb-api-key", ApiKeyArgs.builder()
            .displayName("ksqldb-api-key")
            .description("KsqlDB API Key that is owned by 'app-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(app_manager.id())
                .apiVersion(app_manager.apiVersion())
                .kind(app_manager.kind())
                .build())
            .managedResource(ApiKeyManagedResourceArgs.builder()
                .id(main.id())
                .apiVersion(main.apiVersion())
                .kind(main.kind())
                .environments(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

    }
}
Copy
resources:
  ksqldb-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: ksqldb-api-key
      description: KsqlDB API Key that is owned by 'app-manager' service account
      owner:
        id: ${["app-manager"].id}
        apiVersion: ${["app-manager"].apiVersion}
        kind: ${["app-manager"].kind}
      managedResource:
        id: ${main.id}
        apiVersion: ${main.apiVersion}
        kind: ${main.kind}
        environments:
          - id: ${staging.id}
Copy

Example Schema Registry API Key

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceArgs;
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) {
        var env_manager_schema_registry_api_key = new ApiKey("env-manager-schema-registry-api-key", ApiKeyArgs.builder()
            .displayName("env-manager-schema-registry-api-key")
            .description("Schema Registry API Key that is owned by 'env-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(env_manager.id())
                .apiVersion(env_manager.apiVersion())
                .kind(env_manager.kind())
                .build())
            .managedResource(ApiKeyManagedResourceArgs.builder()
                .id(essentials.id())
                .apiVersion(essentials.apiVersion())
                .kind(essentials.kind())
                .environments(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

    }
}
Copy
resources:
  env-manager-schema-registry-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: env-manager-schema-registry-api-key
      description: Schema Registry API Key that is owned by 'env-manager' service account
      owner:
        id: ${["env-manager"].id}
        apiVersion: ${["env-manager"].apiVersion}
        kind: ${["env-manager"].kind}
      managedResource:
        id: ${essentials.id}
        apiVersion: ${essentials.apiVersion}
        kind: ${essentials.kind}
        environments:
          - id: ${staging.id}
Copy
Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceArgs;
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) {
        var env_manager_flink_api_key = new ApiKey("env-manager-flink-api-key", ApiKeyArgs.builder()
            .displayName("env-manager-flink-api-key")
            .description("Flink API Key that is owned by 'env-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(env_manager.id())
                .apiVersion(env_manager.apiVersion())
                .kind(env_manager.kind())
                .build())
            .managedResource(ApiKeyManagedResourceArgs.builder()
                .id(example.id())
                .apiVersion(example.apiVersion())
                .kind(example.kind())
                .environments(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

    }
}
Copy
resources:
  env-manager-flink-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: env-manager-flink-api-key
      description: Flink API Key that is owned by 'env-manager' service account
      owner:
        id: ${["env-manager"].id}
        apiVersion: ${["env-manager"].apiVersion}
        kind: ${["env-manager"].kind}
      managedResource:
        id: ${example.id}
        apiVersion: ${example.apiVersion}
        kind: ${example.kind}
        environments:
          - id: ${staging.id}
Copy

Example Tableflow API Key

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

const env_manager_tableflow_api_key = new confluentcloud.ApiKey("env-manager-tableflow-api-key", {
    displayName: "env-manager-tableflow-api-key",
    description: "Tableflow API Key that is owned by 'env-manager' service account",
    owner: {
        id: env_manager.id,
        apiVersion: env_manager.apiVersion,
        kind: env_manager.kind,
    },
    managedResource: {
        id: "tableflow",
        apiVersion: "tableflow/v1",
        kind: "Tableflow",
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

env_manager_tableflow_api_key = confluentcloud.ApiKey("env-manager-tableflow-api-key",
    display_name="env-manager-tableflow-api-key",
    description="Tableflow API Key that is owned by 'env-manager' service account",
    owner={
        "id": env_manager["id"],
        "api_version": env_manager["apiVersion"],
        "kind": env_manager["kind"],
    },
    managed_resource={
        "id": "tableflow",
        "api_version": "tableflow/v1",
        "kind": "Tableflow",
    })
Copy
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 {
		_, err := confluentcloud.NewApiKey(ctx, "env-manager-tableflow-api-key", &confluentcloud.ApiKeyArgs{
			DisplayName: pulumi.String("env-manager-tableflow-api-key"),
			Description: pulumi.String("Tableflow API Key that is owned by 'env-manager' service account"),
			Owner: &confluentcloud.ApiKeyOwnerArgs{
				Id:         pulumi.Any(env_manager.Id),
				ApiVersion: pulumi.Any(env_manager.ApiVersion),
				Kind:       pulumi.Any(env_manager.Kind),
			},
			ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
				Id:         pulumi.String("tableflow"),
				ApiVersion: pulumi.String("tableflow/v1"),
				Kind:       pulumi.String("Tableflow"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var env_manager_tableflow_api_key = new ConfluentCloud.ApiKey("env-manager-tableflow-api-key", new()
    {
        DisplayName = "env-manager-tableflow-api-key",
        Description = "Tableflow API Key that is owned by 'env-manager' service account",
        Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
        {
            Id = env_manager.Id,
            ApiVersion = env_manager.ApiVersion,
            Kind = env_manager.Kind,
        },
        ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
        {
            Id = "tableflow",
            ApiVersion = "tableflow/v1",
            Kind = "Tableflow",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceArgs;
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) {
        var env_manager_tableflow_api_key = new ApiKey("env-manager-tableflow-api-key", ApiKeyArgs.builder()
            .displayName("env-manager-tableflow-api-key")
            .description("Tableflow API Key that is owned by 'env-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(env_manager.id())
                .apiVersion(env_manager.apiVersion())
                .kind(env_manager.kind())
                .build())
            .managedResource(ApiKeyManagedResourceArgs.builder()
                .id("tableflow")
                .apiVersion("tableflow/v1")
                .kind("Tableflow")
                .build())
            .build());

    }
}
Copy
resources:
  env-manager-tableflow-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: env-manager-tableflow-api-key
      description: Tableflow API Key that is owned by 'env-manager' service account
      owner:
        id: ${["env-manager"].id}
        apiVersion: ${["env-manager"].apiVersion}
        kind: ${["env-manager"].kind}
      managedResource:
        id: tableflow
        apiVersion: tableflow/v1
        kind: Tableflow
Copy

Example Cloud API Key

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

const env_manager_cloud_api_key = new confluentcloud.ApiKey("env-manager-cloud-api-key", {
    displayName: "env-manager-cloud-api-key",
    description: "Cloud API Key that is owned by 'env-manager' service account",
    owner: {
        id: env_manager.id,
        apiVersion: env_manager.apiVersion,
        kind: env_manager.kind,
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

env_manager_cloud_api_key = confluentcloud.ApiKey("env-manager-cloud-api-key",
    display_name="env-manager-cloud-api-key",
    description="Cloud API Key that is owned by 'env-manager' service account",
    owner={
        "id": env_manager["id"],
        "api_version": env_manager["apiVersion"],
        "kind": env_manager["kind"],
    })
Copy
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 {
		_, err := confluentcloud.NewApiKey(ctx, "env-manager-cloud-api-key", &confluentcloud.ApiKeyArgs{
			DisplayName: pulumi.String("env-manager-cloud-api-key"),
			Description: pulumi.String("Cloud API Key that is owned by 'env-manager' service account"),
			Owner: &confluentcloud.ApiKeyOwnerArgs{
				Id:         pulumi.Any(env_manager.Id),
				ApiVersion: pulumi.Any(env_manager.ApiVersion),
				Kind:       pulumi.Any(env_manager.Kind),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var env_manager_cloud_api_key = new ConfluentCloud.ApiKey("env-manager-cloud-api-key", new()
    {
        DisplayName = "env-manager-cloud-api-key",
        Description = "Cloud API Key that is owned by 'env-manager' service account",
        Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
        {
            Id = env_manager.Id,
            ApiVersion = env_manager.ApiVersion,
            Kind = env_manager.Kind,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ApiKey;
import com.pulumi.confluentcloud.ApiKeyArgs;
import com.pulumi.confluentcloud.inputs.ApiKeyOwnerArgs;
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) {
        var env_manager_cloud_api_key = new ApiKey("env-manager-cloud-api-key", ApiKeyArgs.builder()
            .displayName("env-manager-cloud-api-key")
            .description("Cloud API Key that is owned by 'env-manager' service account")
            .owner(ApiKeyOwnerArgs.builder()
                .id(env_manager.id())
                .apiVersion(env_manager.apiVersion())
                .kind(env_manager.kind())
                .build())
            .build());

    }
}
Copy
resources:
  env-manager-cloud-api-key:
    type: confluentcloud:ApiKey
    properties:
      displayName: env-manager-cloud-api-key
      description: Cloud API Key that is owned by 'env-manager' service account
      owner:
        id: ${["env-manager"].id}
        apiVersion: ${["env-manager"].apiVersion}
        kind: ${["env-manager"].kind}
Copy

Getting Started

The following end-to-end examples might help to get started with confluentcloud.ApiKey resource:

  • basic-kafka-acls: Basic Kafka cluster with authorization using ACLs
  • basic-kafka-acls-with-alias: Basic Kafka cluster with authorization using ACLs
  • standard-kafka-acls: Standard Kafka cluster with authorization using ACLs
  • standard-kafka-rbac: Standard Kafka cluster with authorization using RBAC
  • dedicated-public-kafka-acls: Dedicated Kafka cluster that is accessible over the public internet with authorization using ACLs
  • dedicated-public-kafka-rbac: Dedicated Kafka cluster that is accessible over the public internet with authorization using RBAC
  • dedicated-privatelink-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
  • dedicated-privatelink-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBAC
  • dedicated-privatelink-azure-kafka-rbac: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBAC
  • dedicated-privatelink-azure-kafka-acls: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs
  • dedicated-private-service-connect-gcp-kafka-acls: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLs
  • dedicated-private-service-connect-gcp-kafka-rbac: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBAC
  • dedicated-vnet-peering-azure-kafka-acls: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vnet-peering-azure-kafka-rbac: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-vpc-peering-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vpc-peering-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-vpc-peering-gcp-kafka-acls: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLs
  • dedicated-vpc-peering-gcp-kafka-rbac: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBAC
  • dedicated-transit-gateway-attachment-aws-kafka-acls: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLs
  • dedicated-transit-gateway-attachment-aws-kafka-rbac: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBAC
  • enterprise-privatelinkattachment-aws-kafka-acls: Enterprise Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs

Create ApiKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
@overload
def ApiKey(resource_name: str,
           args: ApiKeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           owner: Optional[ApiKeyOwnerArgs] = None,
           description: Optional[str] = None,
           disable_wait_for_ready: Optional[bool] = None,
           display_name: Optional[str] = None,
           managed_resource: Optional[ApiKeyManagedResourceArgs] = None)
func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

type: confluentcloud:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiKeyResource = new ConfluentCloud.ApiKey("apiKeyResource", new()
{
    Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
    {
        ApiVersion = "string",
        Id = "string",
        Kind = "string",
    },
    Description = "string",
    DisableWaitForReady = false,
    DisplayName = "string",
    ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
    {
        ApiVersion = "string",
        Id = "string",
        Kind = "string",
        Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
        {
            Id = "string",
        },
    },
});
Copy
example, err := confluentcloud.NewApiKey(ctx, "apiKeyResource", &confluentcloud.ApiKeyArgs{
	Owner: &confluentcloud.ApiKeyOwnerArgs{
		ApiVersion: pulumi.String("string"),
		Id:         pulumi.String("string"),
		Kind:       pulumi.String("string"),
	},
	Description:         pulumi.String("string"),
	DisableWaitForReady: pulumi.Bool(false),
	DisplayName:         pulumi.String("string"),
	ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
		ApiVersion: pulumi.String("string"),
		Id:         pulumi.String("string"),
		Kind:       pulumi.String("string"),
		Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
			Id: pulumi.String("string"),
		},
	},
})
Copy
var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .owner(ApiKeyOwnerArgs.builder()
        .apiVersion("string")
        .id("string")
        .kind("string")
        .build())
    .description("string")
    .disableWaitForReady(false)
    .displayName("string")
    .managedResource(ApiKeyManagedResourceArgs.builder()
        .apiVersion("string")
        .id("string")
        .kind("string")
        .environment(ApiKeyManagedResourceEnvironmentArgs.builder()
            .id("string")
            .build())
        .build())
    .build());
Copy
api_key_resource = confluentcloud.ApiKey("apiKeyResource",
    owner={
        "api_version": "string",
        "id": "string",
        "kind": "string",
    },
    description="string",
    disable_wait_for_ready=False,
    display_name="string",
    managed_resource={
        "api_version": "string",
        "id": "string",
        "kind": "string",
        "environment": {
            "id": "string",
        },
    })
Copy
const apiKeyResource = new confluentcloud.ApiKey("apiKeyResource", {
    owner: {
        apiVersion: "string",
        id: "string",
        kind: "string",
    },
    description: "string",
    disableWaitForReady: false,
    displayName: "string",
    managedResource: {
        apiVersion: "string",
        id: "string",
        kind: "string",
        environment: {
            id: "string",
        },
    },
});
Copy
type: confluentcloud:ApiKey
properties:
    description: string
    disableWaitForReady: false
    displayName: string
    managedResource:
        apiVersion: string
        environment:
            id: string
        id: string
        kind: string
    owner:
        apiVersion: string
        id: string
        kind: string
Copy

ApiKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiKey resource accepts the following input properties:

Owner
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
Description string
A free-form description of the API Account.
DisableWaitForReady Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
DisplayName string
A human-readable name for the API Key.
ManagedResource Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
Owner
This property is required.
Changes to this property will trigger replacement.
ApiKeyOwnerArgs
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
Description string
A free-form description of the API Account.
DisableWaitForReady Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
DisplayName string
A human-readable name for the API Key.
ManagedResource Changes to this property will trigger replacement. ApiKeyManagedResourceArgs
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner
This property is required.
Changes to this property will trigger replacement.
ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
description String
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. Boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName String
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner
This property is required.
Changes to this property will trigger replacement.
ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
description string
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName string
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner
This property is required.
Changes to this property will trigger replacement.
ApiKeyOwnerArgs
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
description str
A free-form description of the API Account.
disable_wait_for_ready Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
display_name str
A human-readable name for the API Key.
managed_resource Changes to this property will trigger replacement. ApiKeyManagedResourceArgs
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner
This property is required.
Changes to this property will trigger replacement.
Property Map
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
description String
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. Boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName String
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. Property Map
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Secret string
(Required String, Sensitive) The secret of the API Key.
Id string
The provider-assigned unique ID for this managed resource.
Secret string
(Required String, Sensitive) The secret of the API Key.
id String
The provider-assigned unique ID for this managed resource.
secret String
(Required String, Sensitive) The secret of the API Key.
id string
The provider-assigned unique ID for this managed resource.
secret string
(Required String, Sensitive) The secret of the API Key.
id str
The provider-assigned unique ID for this managed resource.
secret str
(Required String, Sensitive) The secret of the API Key.
id String
The provider-assigned unique ID for this managed resource.
secret String
(Required String, Sensitive) The secret of the API Key.

Look up Existing ApiKey Resource

Get an existing ApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiKeyState, opts?: CustomResourceOptions): ApiKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_wait_for_ready: Optional[bool] = None,
        display_name: Optional[str] = None,
        managed_resource: Optional[ApiKeyManagedResourceArgs] = None,
        owner: Optional[ApiKeyOwnerArgs] = None,
        secret: Optional[str] = None) -> ApiKey
func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)
public static ApiKey Get(string name, Input<string> id, ApiKeyState? state, CustomResourceOptions? opts = null)
public static ApiKey get(String name, Output<String> id, ApiKeyState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:ApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
A free-form description of the API Account.
DisableWaitForReady Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
DisplayName string
A human-readable name for the API Key.
ManagedResource Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
Owner Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
Secret string
(Required String, Sensitive) The secret of the API Key.
Description string
A free-form description of the API Account.
DisableWaitForReady Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
DisplayName string
A human-readable name for the API Key.
ManagedResource Changes to this property will trigger replacement. ApiKeyManagedResourceArgs
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
Owner Changes to this property will trigger replacement. ApiKeyOwnerArgs
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
Secret string
(Required String, Sensitive) The secret of the API Key.
description String
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. Boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName String
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner Changes to this property will trigger replacement. ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
secret String
(Required String, Sensitive) The secret of the API Key.
description string
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName string
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. ApiKeyManagedResource
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner Changes to this property will trigger replacement. ApiKeyOwner
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
secret string
(Required String, Sensitive) The secret of the API Key.
description str
A free-form description of the API Account.
disable_wait_for_ready Changes to this property will trigger replacement. bool
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
display_name str
A human-readable name for the API Key.
managed_resource Changes to this property will trigger replacement. ApiKeyManagedResourceArgs
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner Changes to this property will trigger replacement. ApiKeyOwnerArgs
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
secret str
(Required String, Sensitive) The secret of the API Key.
description String
A free-form description of the API Account.
disableWaitForReady Changes to this property will trigger replacement. Boolean
An optional flag to disable wait-for-readiness on create. Its primary use case is for Cluster API Keys for private networking options when readiness check fails. Must be unset when importing. Defaults to false.
displayName String
A human-readable name for the API Key.
managedResource Changes to this property will trigger replacement. Property Map
The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
owner Changes to this property will trigger replacement. Property Map
The owner to which the API Key belongs. The owner can be one of 'iam.v2.User', 'iam.v2.ServiceAccount'.
secret String
(Required String, Sensitive) The secret of the API Key.

Supporting Types

ApiKeyManagedResource
, ApiKeyManagedResourceArgs

ApiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
Kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the managed resource that the API Key associated with, for example, Cluster.
Environment Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironment
ApiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
Kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the managed resource that the API Key associated with, for example, Cluster.
Environment ApiKeyManagedResourceEnvironment
apiVersion
This property is required.
Changes to this property will trigger replacement.
String
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
String
The kind of the managed resource that the API Key associated with, for example, Cluster.
environment ApiKeyManagedResourceEnvironment
apiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the managed resource that the API Key associated with, for example, Cluster.
environment ApiKeyManagedResourceEnvironment
api_version
This property is required.
Changes to this property will trigger replacement.
str
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
str
The kind of the managed resource that the API Key associated with, for example, Cluster.
environment ApiKeyManagedResourceEnvironment
apiVersion
This property is required.
Changes to this property will trigger replacement.
String
The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the managed resource that the API Key associated with, for example, lkc-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
String
The kind of the managed resource that the API Key associated with, for example, Cluster.
environment Property Map

ApiKeyManagedResourceEnvironment
, ApiKeyManagedResourceEnvironmentArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the managed resource belongs to, for example, env-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the managed resource belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the managed resource belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Environment that the managed resource belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Environment that the managed resource belongs to, for example, env-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Environment that the managed resource belongs to, for example, env-abc123.

ApiKeyOwner
, ApiKeyOwnerArgs

ApiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
Kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.
ApiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
Kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.
apiVersion
This property is required.
Changes to this property will trigger replacement.
String
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
String
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.
apiVersion
This property is required.
Changes to this property will trigger replacement.
string
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
string
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.
api_version
This property is required.
Changes to this property will trigger replacement.
str
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
str
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.
apiVersion
This property is required.
Changes to this property will trigger replacement.
String
The API group and version of the owner that the API Key belongs to, for example, iam/v2.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the owner that the API Key belongs to, for example, sa-abc123 or u-abc123.
kind
This property is required.
Changes to this property will trigger replacement.
String
The kind of the owner that the API Key belongs to, for example, ServiceAccount or User.

Import

You can import a Cluster API Key by using the Environment ID and Cluster API Key ID in the format <Environment ID>/<Cluster API Key ID>, for example:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ export API_KEY_SECRET="<api_key_secret>"

Option #1: Cluster API Key

$ pulumi import confluentcloud:index/apiKey:ApiKey example_kafka_api_key "env-abc123/UTT6WDRXX7FHD2GV"
Copy

You can import a Cloud or Tableflow API Key by using Cloud or Tableflow API Key ID, for example:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ export API_KEY_SECRET="<api_key_secret>"

Option #2: Cloud or Tableflow API Key

$ pulumi import confluentcloud:index/apiKey:ApiKey example_cloud_api_key "4UEXOMMWIBE5KZQG"
Copy

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud