confluentcloud.ApiKey
Explore with Pulumi AI
Example Usage
Example Kafka API Key
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const app_manager_kafka_api_key = new confluentcloud.ApiKey("app-manager-kafka-api-key", {
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,
environment: {
id: staging.id,
},
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
app_manager_kafka_api_key = confluentcloud.ApiKey("app-manager-kafka-api-key",
display_name="app-manager-kafka-api-key",
description="Kafka API Key that is owned by 'app-manager' service account",
owner={
"id": app_manager["id"],
"api_version": app_manager["apiVersion"],
"kind": app_manager["kind"],
},
managed_resource={
"id": basic["id"],
"api_version": basic["apiVersion"],
"kind": basic["kind"],
"environment": {
"id": staging["id"],
},
})
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, "app-manager-kafka-api-key", &confluentcloud.ApiKeyArgs{
DisplayName: pulumi.String("app-manager-kafka-api-key"),
Description: pulumi.String("Kafka API Key that is owned by 'app-manager' service account"),
Owner: &confluentcloud.ApiKeyOwnerArgs{
Id: pulumi.Any(app_manager.Id),
ApiVersion: pulumi.Any(app_manager.ApiVersion),
Kind: pulumi.Any(app_manager.Kind),
},
ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
Id: pulumi.Any(basic.Id),
ApiVersion: pulumi.Any(basic.ApiVersion),
Kind: pulumi.Any(basic.Kind),
Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
Id: pulumi.Any(staging.Id),
},
},
})
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 app_manager_kafka_api_key = new ConfluentCloud.ApiKey("app-manager-kafka-api-key", new()
{
DisplayName = "app-manager-kafka-api-key",
Description = "Kafka API Key that is owned by 'app-manager' service account",
Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
{
Id = app_manager.Id,
ApiVersion = app_manager.ApiVersion,
Kind = app_manager.Kind,
},
ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
{
Id = basic.Id,
ApiVersion = basic.ApiVersion,
Kind = basic.Kind,
Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
{
Id = staging.Id,
},
},
});
});
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 com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceEnvironmentArgs;
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())
.environment(ApiKeyManagedResourceEnvironmentArgs.builder()
.id(staging.id())
.build())
.build())
.build());
}
}
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}
environment:
id: ${staging.id}
Example ksqlDB API Key
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const ksqldb_api_key = new confluentcloud.ApiKey("ksqldb-api-key", {
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,
environment: {
id: staging.id,
},
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
ksqldb_api_key = confluentcloud.ApiKey("ksqldb-api-key",
display_name="ksqldb-api-key",
description="KsqlDB API Key that is owned by 'app-manager' service account",
owner={
"id": app_manager["id"],
"api_version": app_manager["apiVersion"],
"kind": app_manager["kind"],
},
managed_resource={
"id": main["id"],
"api_version": main["apiVersion"],
"kind": main["kind"],
"environment": {
"id": staging["id"],
},
})
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, "ksqldb-api-key", &confluentcloud.ApiKeyArgs{
DisplayName: pulumi.String("ksqldb-api-key"),
Description: pulumi.String("KsqlDB API Key that is owned by 'app-manager' service account"),
Owner: &confluentcloud.ApiKeyOwnerArgs{
Id: pulumi.Any(app_manager.Id),
ApiVersion: pulumi.Any(app_manager.ApiVersion),
Kind: pulumi.Any(app_manager.Kind),
},
ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
Id: pulumi.Any(main.Id),
ApiVersion: pulumi.Any(main.ApiVersion),
Kind: pulumi.Any(main.Kind),
Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
Id: pulumi.Any(staging.Id),
},
},
})
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 ksqldb_api_key = new ConfluentCloud.ApiKey("ksqldb-api-key", new()
{
DisplayName = "ksqldb-api-key",
Description = "KsqlDB API Key that is owned by 'app-manager' service account",
Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
{
Id = app_manager.Id,
ApiVersion = app_manager.ApiVersion,
Kind = app_manager.Kind,
},
ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
{
Id = main.Id,
ApiVersion = main.ApiVersion,
Kind = main.Kind,
Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
{
Id = staging.Id,
},
},
});
});
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 com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceEnvironmentArgs;
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())
.environment(ApiKeyManagedResourceEnvironmentArgs.builder()
.id(staging.id())
.build())
.build())
.build());
}
}
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}
environment:
id: ${staging.id}
Example Schema Registry API Key
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const env_manager_schema_registry_api_key = new confluentcloud.ApiKey("env-manager-schema-registry-api-key", {
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,
environment: {
id: staging.id,
},
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
env_manager_schema_registry_api_key = confluentcloud.ApiKey("env-manager-schema-registry-api-key",
display_name="env-manager-schema-registry-api-key",
description="Schema Registry 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": essentials["id"],
"api_version": essentials["apiVersion"],
"kind": essentials["kind"],
"environment": {
"id": staging["id"],
},
})
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-schema-registry-api-key", &confluentcloud.ApiKeyArgs{
DisplayName: pulumi.String("env-manager-schema-registry-api-key"),
Description: pulumi.String("Schema Registry 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.Any(essentials.Id),
ApiVersion: pulumi.Any(essentials.ApiVersion),
Kind: pulumi.Any(essentials.Kind),
Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
Id: pulumi.Any(staging.Id),
},
},
})
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 env_manager_schema_registry_api_key = new ConfluentCloud.ApiKey("env-manager-schema-registry-api-key", new()
{
DisplayName = "env-manager-schema-registry-api-key",
Description = "Schema Registry 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 = essentials.Id,
ApiVersion = essentials.ApiVersion,
Kind = essentials.Kind,
Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
{
Id = staging.Id,
},
},
});
});
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 com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceEnvironmentArgs;
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())
.environment(ApiKeyManagedResourceEnvironmentArgs.builder()
.id(staging.id())
.build())
.build())
.build());
}
}
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}
environment:
id: ${staging.id}
Example Flink API Key
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const env_manager_flink_api_key = new confluentcloud.ApiKey("env-manager-flink-api-key", {
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,
environment: {
id: staging.id,
},
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
env_manager_flink_api_key = confluentcloud.ApiKey("env-manager-flink-api-key",
display_name="env-manager-flink-api-key",
description="Flink 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": example["id"],
"api_version": example["apiVersion"],
"kind": example["kind"],
"environment": {
"id": staging["id"],
},
})
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-flink-api-key", &confluentcloud.ApiKeyArgs{
DisplayName: pulumi.String("env-manager-flink-api-key"),
Description: pulumi.String("Flink 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.Any(example.Id),
ApiVersion: pulumi.Any(example.ApiVersion),
Kind: pulumi.Any(example.Kind),
Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
Id: pulumi.Any(staging.Id),
},
},
})
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 env_manager_flink_api_key = new ConfluentCloud.ApiKey("env-manager-flink-api-key", new()
{
DisplayName = "env-manager-flink-api-key",
Description = "Flink 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 = example.Id,
ApiVersion = example.ApiVersion,
Kind = example.Kind,
Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
{
Id = staging.Id,
},
},
});
});
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 com.pulumi.confluentcloud.inputs.ApiKeyManagedResourceEnvironmentArgs;
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())
.environment(ApiKeyManagedResourceEnvironmentArgs.builder()
.id(staging.id())
.build())
.build())
.build());
}
}
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}
environment:
id: ${staging.id}
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,
},
});
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"],
})
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
})
}
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,
},
});
});
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());
}
}
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}
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 ACLsbasic-kafka-acls-with-alias
: Basic Kafka cluster with authorization using ACLsstandard-kafka-acls
: Standard Kafka cluster with authorization using ACLsstandard-kafka-rbac
: Standard Kafka cluster with authorization using RBACdedicated-public-kafka-acls
: Dedicated Kafka cluster that is accessible over the public internet with authorization using ACLsdedicated-public-kafka-rbac
: Dedicated Kafka cluster that is accessible over the public internet with authorization using RBACdedicated-privatelink-aws-kafka-acls
: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLsdedicated-privatelink-aws-kafka-rbac
: Dedicated Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using RBACdedicated-privatelink-azure-kafka-rbac
: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using RBACdedicated-privatelink-azure-kafka-acls
: Dedicated Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLsdedicated-private-service-connect-gcp-kafka-acls
: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using ACLsdedicated-private-service-connect-gcp-kafka-rbac
: Dedicated Kafka cluster on GCP that is accessible via Private Service Connect connections with authorization using RBACdedicated-vnet-peering-azure-kafka-acls
: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using ACLsdedicated-vnet-peering-azure-kafka-rbac
: Dedicated Kafka cluster on Azure that is accessible via VPC Peering connections with authorization using RBACdedicated-vpc-peering-aws-kafka-acls
: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using ACLsdedicated-vpc-peering-aws-kafka-rbac
: Dedicated Kafka cluster on AWS that is accessible via VPC Peering connections with authorization using RBACdedicated-vpc-peering-gcp-kafka-acls
: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using ACLsdedicated-vpc-peering-gcp-kafka-rbac
: Dedicated Kafka cluster on GCP that is accessible via VPC Peering connections with authorization using RBACdedicated-transit-gateway-attachment-aws-kafka-acls
: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using ACLsdedicated-transit-gateway-attachment-aws-kafka-rbac
: Dedicated Kafka cluster on AWS that is accessible via Transit Gateway Endpoint with authorization using RBACenterprise-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 string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiKeyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
{
Id = "string",
},
Id = "string",
Kind = "string",
},
});
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"),
Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
Id: pulumi.String("string"),
},
Id: pulumi.String("string"),
Kind: pulumi.String("string"),
},
})
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")
.environment(ApiKeyManagedResourceEnvironmentArgs.builder()
.id("string")
.build())
.id("string")
.kind("string")
.build())
.build());
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",
"environment": {
"id": "string",
},
"id": "string",
"kind": "string",
})
const apiKeyResource = new confluentcloud.ApiKey("apiKeyResource", {
owner: {
apiVersion: "string",
id: "string",
kind: "string",
},
description: "string",
disableWaitForReady: false,
displayName: "string",
managedResource: {
apiVersion: "string",
environment: {
id: "string",
},
id: "string",
kind: "string",
},
});
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
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
Pulumi.
Confluent Cloud. Inputs. Api Key Owner - 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.
- Disable
Wait boolFor Ready - 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 string - A human-readable name for the API Key.
- Managed
Resource Pulumi.Confluent Cloud. Inputs. Api Key Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- Owner
Api
Key Owner Args - 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.
- Disable
Wait boolFor Ready - 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 string - A human-readable name for the API Key.
- Managed
Resource ApiKey Managed Resource Args - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner - 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.
- disable
Wait BooleanFor Ready - 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 String - A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner - 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.
- disable
Wait booleanFor Ready - 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 string - A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner Args - 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_ boolfor_ ready - 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 ApiKey Managed Resource Args - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner 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.
- disable
Wait BooleanFor Ready - 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 String - A human-readable name for the API Key.
- managed
Resource 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:
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Description string
- A free-form description of the API Account.
- Disable
Wait boolFor Ready - 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 string - A human-readable name for the API Key.
- Managed
Resource Pulumi.Confluent Cloud. Inputs. Api Key Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- Owner
Pulumi.
Confluent Cloud. Inputs. Api Key Owner - 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.
- Disable
Wait boolFor Ready - 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 string - A human-readable name for the API Key.
- Managed
Resource ApiKey Managed Resource Args - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- Owner
Api
Key Owner Args - 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.
- disable
Wait BooleanFor Ready - 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 String - A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner - 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.
- disable
Wait booleanFor Ready - 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 string - A human-readable name for the API Key.
- managed
Resource ApiKey Managed Resource - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner - 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_ boolfor_ ready - 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 ApiKey Managed Resource Args - The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster', 'srcm.v3.Cluster'.
- owner
Api
Key Owner Args - 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.
- disable
Wait BooleanFor Ready - 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 String - A human-readable name for the API Key.
- managed
Resource 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 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
- Api
Version string - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - Environment
Pulumi.
Confluent Cloud. Inputs. Api Key Managed Resource Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Id string
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - Kind string
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- Api
Version string - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - Environment
Api
Key Managed Resource Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Id string
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - Kind string
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - environment
Api
Key Managed Resource Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- id String
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - kind String
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version string - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - environment
Api
Key Managed Resource Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- id string
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - kind string
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api_
version str - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - environment
Api
Key Managed Resource Environment - Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- id str
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - kind str
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
- api
Version String - The API group and version of the managed resource that the API Key associated with, for example,
cmk/v2
. - environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- id String
- The ID of the managed resource that the API Key associated with, for example,
lkc-abc123
. - kind String
- The kind of the managed resource that the API Key associated with, for example,
Cluster
.
ApiKeyManagedResourceEnvironment, ApiKeyManagedResourceEnvironmentArgs
- Id string
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- Id string
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id string
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id str
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
- id String
- The ID of the Environment that the managed resource belongs to, for example,
env-abc123
.
ApiKeyOwner, ApiKeyOwnerArgs
- Api
Version string - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - Id string
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - Kind string
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
- Api
Version string - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - Id string
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - Kind string
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
- api
Version String - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - id String
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - kind String
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
- api
Version string - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - id string
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - kind string
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
- api_
version str - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - id str
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - kind str
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
- api
Version String - The API group and version of the owner that the API Key belongs to, for example,
iam/v2
. - id String
- The ID of the owner that the API Key belongs to, for example,
sa-abc123
oru-abc123
. - kind String
- The kind of the owner that the API Key belongs to, for example,
ServiceAccount
orUser
.
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"
You can import a Cloud API Key by using Cloud 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 API Key
$ pulumi import confluentcloud:index/apiKey:ApiKey example_cloud_api_key "4UEXOMMWIBE5KZQG"
!> 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.