1. Packages
  2. Confluent Cloud
  3. API Docs
  4. ApiKey
Confluent v1.41.0 published on Saturday, Apr 13, 2024 by Pulumi

confluentcloud.ApiKey

Explore with Pulumi AI

confluentcloud logo
Confluent v1.41.0 published on Saturday, Apr 13, 2024 by Pulumi

    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", {
        description: "Kafka API Key that is owned by 'app-manager' service account",
        owner: {
            id: confluent_service_account["app-manager"].id,
            apiVersion: confluent_service_account["app-manager"].api_version,
            kind: confluent_service_account["app-manager"].kind,
        },
        managedResource: {
            id: confluent_kafka_cluster.basic.id,
            apiVersion: confluent_kafka_cluster.basic.api_version,
            kind: confluent_kafka_cluster.basic.kind,
            environment: {
                id: confluent_environment.staging.id,
            },
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    app_manager_kafka_api_key = confluentcloud.ApiKey("app-manager-kafka-api-key",
        description="Kafka API Key that is owned by 'app-manager' service account",
        owner=confluentcloud.ApiKeyOwnerArgs(
            id=confluent_service_account["app-manager"]["id"],
            api_version=confluent_service_account["app-manager"]["api_version"],
            kind=confluent_service_account["app-manager"]["kind"],
        ),
        managed_resource=confluentcloud.ApiKeyManagedResourceArgs(
            id=confluent_kafka_cluster["basic"]["id"],
            api_version=confluent_kafka_cluster["basic"]["api_version"],
            kind=confluent_kafka_cluster["basic"]["kind"],
            environment=confluentcloud.ApiKeyManagedResourceEnvironmentArgs(
                id=confluent_environment["staging"]["id"],
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewApiKey(ctx, "app-manager-kafka-api-key", &confluentcloud.ApiKeyArgs{
    			Description: pulumi.String("Kafka API Key that is owned by 'app-manager' service account"),
    			Owner: &confluentcloud.ApiKeyOwnerArgs{
    				Id:         pulumi.Any(confluent_service_account.AppManager.Id),
    				ApiVersion: pulumi.Any(confluent_service_account.AppManager.Api_version),
    				Kind:       pulumi.Any(confluent_service_account.AppManager.Kind),
    			},
    			ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
    				Id:         pulumi.Any(confluent_kafka_cluster.Basic.Id),
    				ApiVersion: pulumi.Any(confluent_kafka_cluster.Basic.Api_version),
    				Kind:       pulumi.Any(confluent_kafka_cluster.Basic.Kind),
    				Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
    					Id: pulumi.Any(confluent_environment.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()
        {
            Description = "Kafka API Key that is owned by 'app-manager' service account",
            Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
            {
                Id = confluent_service_account.App_manager.Id,
                ApiVersion = confluent_service_account.App_manager.Api_version,
                Kind = confluent_service_account.App_manager.Kind,
            },
            ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
            {
                Id = confluent_kafka_cluster.Basic.Id,
                ApiVersion = confluent_kafka_cluster.Basic.Api_version,
                Kind = confluent_kafka_cluster.Basic.Kind,
                Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
                {
                    Id = confluent_environment.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()        
                .description("Kafka API Key that is owned by 'app-manager' service account")
                .owner(ApiKeyOwnerArgs.builder()
                    .id(confluent_service_account.app-manager().id())
                    .apiVersion(confluent_service_account.app-manager().api_version())
                    .kind(confluent_service_account.app-manager().kind())
                    .build())
                .managedResource(ApiKeyManagedResourceArgs.builder()
                    .id(confluent_kafka_cluster.basic().id())
                    .apiVersion(confluent_kafka_cluster.basic().api_version())
                    .kind(confluent_kafka_cluster.basic().kind())
                    .environment(ApiKeyManagedResourceEnvironmentArgs.builder()
                        .id(confluent_environment.staging().id())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      app-manager-kafka-api-key:
        type: confluentcloud:ApiKey
        properties:
          description: Kafka API Key that is owned by 'app-manager' service account
          owner:
            id: ${confluent_service_account"app-manager"[%!s(MISSING)].id}
            apiVersion: ${confluent_service_account"app-manager"[%!s(MISSING)].api_version}
            kind: ${confluent_service_account"app-manager"[%!s(MISSING)].kind}
          managedResource:
            id: ${confluent_kafka_cluster.basic.id}
            apiVersion: ${confluent_kafka_cluster.basic.api_version}
            kind: ${confluent_kafka_cluster.basic.kind}
            environment:
              id: ${confluent_environment.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", {
        description: "KsqlDB API Key that is owned by 'app-manager' service account",
        owner: {
            id: confluent_service_account["app-manager"].id,
            apiVersion: confluent_service_account["app-manager"].api_version,
            kind: confluent_service_account["app-manager"].kind,
        },
        managedResource: {
            id: confluent_ksql_cluster.main.id,
            apiVersion: confluent_ksql_cluster.main.api_version,
            kind: confluent_ksql_cluster.main.kind,
            environment: {
                id: confluent_environment.staging.id,
            },
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    ksqldb_api_key = confluentcloud.ApiKey("ksqldb-api-key",
        description="KsqlDB API Key that is owned by 'app-manager' service account",
        owner=confluentcloud.ApiKeyOwnerArgs(
            id=confluent_service_account["app-manager"]["id"],
            api_version=confluent_service_account["app-manager"]["api_version"],
            kind=confluent_service_account["app-manager"]["kind"],
        ),
        managed_resource=confluentcloud.ApiKeyManagedResourceArgs(
            id=confluent_ksql_cluster["main"]["id"],
            api_version=confluent_ksql_cluster["main"]["api_version"],
            kind=confluent_ksql_cluster["main"]["kind"],
            environment=confluentcloud.ApiKeyManagedResourceEnvironmentArgs(
                id=confluent_environment["staging"]["id"],
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewApiKey(ctx, "ksqldb-api-key", &confluentcloud.ApiKeyArgs{
    			Description: pulumi.String("KsqlDB API Key that is owned by 'app-manager' service account"),
    			Owner: &confluentcloud.ApiKeyOwnerArgs{
    				Id:         pulumi.Any(confluent_service_account.AppManager.Id),
    				ApiVersion: pulumi.Any(confluent_service_account.AppManager.Api_version),
    				Kind:       pulumi.Any(confluent_service_account.AppManager.Kind),
    			},
    			ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
    				Id:         pulumi.Any(confluent_ksql_cluster.Main.Id),
    				ApiVersion: pulumi.Any(confluent_ksql_cluster.Main.Api_version),
    				Kind:       pulumi.Any(confluent_ksql_cluster.Main.Kind),
    				Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
    					Id: pulumi.Any(confluent_environment.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()
        {
            Description = "KsqlDB API Key that is owned by 'app-manager' service account",
            Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
            {
                Id = confluent_service_account.App_manager.Id,
                ApiVersion = confluent_service_account.App_manager.Api_version,
                Kind = confluent_service_account.App_manager.Kind,
            },
            ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
            {
                Id = confluent_ksql_cluster.Main.Id,
                ApiVersion = confluent_ksql_cluster.Main.Api_version,
                Kind = confluent_ksql_cluster.Main.Kind,
                Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
                {
                    Id = confluent_environment.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()        
                .description("KsqlDB API Key that is owned by 'app-manager' service account")
                .owner(ApiKeyOwnerArgs.builder()
                    .id(confluent_service_account.app-manager().id())
                    .apiVersion(confluent_service_account.app-manager().api_version())
                    .kind(confluent_service_account.app-manager().kind())
                    .build())
                .managedResource(ApiKeyManagedResourceArgs.builder()
                    .id(confluent_ksql_cluster.main().id())
                    .apiVersion(confluent_ksql_cluster.main().api_version())
                    .kind(confluent_ksql_cluster.main().kind())
                    .environment(ApiKeyManagedResourceEnvironmentArgs.builder()
                        .id(confluent_environment.staging().id())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      ksqldb-api-key:
        type: confluentcloud:ApiKey
        properties:
          description: KsqlDB API Key that is owned by 'app-manager' service account
          owner:
            id: ${confluent_service_account"app-manager"[%!s(MISSING)].id}
            apiVersion: ${confluent_service_account"app-manager"[%!s(MISSING)].api_version}
            kind: ${confluent_service_account"app-manager"[%!s(MISSING)].kind}
          managedResource:
            id: ${confluent_ksql_cluster.main.id}
            apiVersion: ${confluent_ksql_cluster.main.api_version}
            kind: ${confluent_ksql_cluster.main.kind}
            environment:
              id: ${confluent_environment.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", {
        description: "Schema Registry API Key that is owned by 'env-manager' service account",
        owner: {
            id: confluent_service_account["env-manager"].id,
            apiVersion: confluent_service_account["env-manager"].api_version,
            kind: confluent_service_account["env-manager"].kind,
        },
        managedResource: {
            id: confluent_schema_registry_cluster.essentials.id,
            apiVersion: confluent_schema_registry_cluster.essentials.api_version,
            kind: confluent_schema_registry_cluster.essentials.kind,
            environment: {
                id: confluent_environment.staging.id,
            },
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    env_manager_schema_registry_api_key = confluentcloud.ApiKey("env-manager-schema-registry-api-key",
        description="Schema Registry API Key that is owned by 'env-manager' service account",
        owner=confluentcloud.ApiKeyOwnerArgs(
            id=confluent_service_account["env-manager"]["id"],
            api_version=confluent_service_account["env-manager"]["api_version"],
            kind=confluent_service_account["env-manager"]["kind"],
        ),
        managed_resource=confluentcloud.ApiKeyManagedResourceArgs(
            id=confluent_schema_registry_cluster["essentials"]["id"],
            api_version=confluent_schema_registry_cluster["essentials"]["api_version"],
            kind=confluent_schema_registry_cluster["essentials"]["kind"],
            environment=confluentcloud.ApiKeyManagedResourceEnvironmentArgs(
                id=confluent_environment["staging"]["id"],
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewApiKey(ctx, "env-manager-schema-registry-api-key", &confluentcloud.ApiKeyArgs{
    			Description: pulumi.String("Schema Registry API Key that is owned by 'env-manager' service account"),
    			Owner: &confluentcloud.ApiKeyOwnerArgs{
    				Id:         pulumi.Any(confluent_service_account.EnvManager.Id),
    				ApiVersion: pulumi.Any(confluent_service_account.EnvManager.Api_version),
    				Kind:       pulumi.Any(confluent_service_account.EnvManager.Kind),
    			},
    			ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
    				Id:         pulumi.Any(confluent_schema_registry_cluster.Essentials.Id),
    				ApiVersion: pulumi.Any(confluent_schema_registry_cluster.Essentials.Api_version),
    				Kind:       pulumi.Any(confluent_schema_registry_cluster.Essentials.Kind),
    				Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
    					Id: pulumi.Any(confluent_environment.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()
        {
            Description = "Schema Registry API Key that is owned by 'env-manager' service account",
            Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
            {
                Id = confluent_service_account.Env_manager.Id,
                ApiVersion = confluent_service_account.Env_manager.Api_version,
                Kind = confluent_service_account.Env_manager.Kind,
            },
            ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
            {
                Id = confluent_schema_registry_cluster.Essentials.Id,
                ApiVersion = confluent_schema_registry_cluster.Essentials.Api_version,
                Kind = confluent_schema_registry_cluster.Essentials.Kind,
                Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
                {
                    Id = confluent_environment.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()        
                .description("Schema Registry API Key that is owned by 'env-manager' service account")
                .owner(ApiKeyOwnerArgs.builder()
                    .id(confluent_service_account.env-manager().id())
                    .apiVersion(confluent_service_account.env-manager().api_version())
                    .kind(confluent_service_account.env-manager().kind())
                    .build())
                .managedResource(ApiKeyManagedResourceArgs.builder()
                    .id(confluent_schema_registry_cluster.essentials().id())
                    .apiVersion(confluent_schema_registry_cluster.essentials().api_version())
                    .kind(confluent_schema_registry_cluster.essentials().kind())
                    .environment(ApiKeyManagedResourceEnvironmentArgs.builder()
                        .id(confluent_environment.staging().id())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      env-manager-schema-registry-api-key:
        type: confluentcloud:ApiKey
        properties:
          description: Schema Registry API Key that is owned by 'env-manager' service account
          owner:
            id: ${confluent_service_account"env-manager"[%!s(MISSING)].id}
            apiVersion: ${confluent_service_account"env-manager"[%!s(MISSING)].api_version}
            kind: ${confluent_service_account"env-manager"[%!s(MISSING)].kind}
          managedResource:
            id: ${confluent_schema_registry_cluster.essentials.id}
            apiVersion: ${confluent_schema_registry_cluster.essentials.api_version}
            kind: ${confluent_schema_registry_cluster.essentials.kind}
            environment:
              id: ${confluent_environment.staging.id}
    
    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", {
        description: "Flink API Key that is owned by 'env-manager' service account",
        owner: {
            id: confluent_service_account["env-manager"].id,
            apiVersion: confluent_service_account["env-manager"].api_version,
            kind: confluent_service_account["env-manager"].kind,
        },
        managedResource: {
            id: data.confluent_flink_region.example.id,
            apiVersion: data.confluent_flink_region.example.api_version,
            kind: data.confluent_flink_region.example.kind,
            environment: {
                id: confluent_environment.staging.id,
            },
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    env_manager_flink_api_key = confluentcloud.ApiKey("env-manager-flink-api-key",
        description="Flink API Key that is owned by 'env-manager' service account",
        owner=confluentcloud.ApiKeyOwnerArgs(
            id=confluent_service_account["env-manager"]["id"],
            api_version=confluent_service_account["env-manager"]["api_version"],
            kind=confluent_service_account["env-manager"]["kind"],
        ),
        managed_resource=confluentcloud.ApiKeyManagedResourceArgs(
            id=data["confluent_flink_region"]["example"]["id"],
            api_version=data["confluent_flink_region"]["example"]["api_version"],
            kind=data["confluent_flink_region"]["example"]["kind"],
            environment=confluentcloud.ApiKeyManagedResourceEnvironmentArgs(
                id=confluent_environment["staging"]["id"],
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewApiKey(ctx, "env-manager-flink-api-key", &confluentcloud.ApiKeyArgs{
    			Description: pulumi.String("Flink API Key that is owned by 'env-manager' service account"),
    			Owner: &confluentcloud.ApiKeyOwnerArgs{
    				Id:         pulumi.Any(confluent_service_account.EnvManager.Id),
    				ApiVersion: pulumi.Any(confluent_service_account.EnvManager.Api_version),
    				Kind:       pulumi.Any(confluent_service_account.EnvManager.Kind),
    			},
    			ManagedResource: &confluentcloud.ApiKeyManagedResourceArgs{
    				Id:         pulumi.Any(data.Confluent_flink_region.Example.Id),
    				ApiVersion: pulumi.Any(data.Confluent_flink_region.Example.Api_version),
    				Kind:       pulumi.Any(data.Confluent_flink_region.Example.Kind),
    				Environment: &confluentcloud.ApiKeyManagedResourceEnvironmentArgs{
    					Id: pulumi.Any(confluent_environment.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()
        {
            Description = "Flink API Key that is owned by 'env-manager' service account",
            Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
            {
                Id = confluent_service_account.Env_manager.Id,
                ApiVersion = confluent_service_account.Env_manager.Api_version,
                Kind = confluent_service_account.Env_manager.Kind,
            },
            ManagedResource = new ConfluentCloud.Inputs.ApiKeyManagedResourceArgs
            {
                Id = data.Confluent_flink_region.Example.Id,
                ApiVersion = data.Confluent_flink_region.Example.Api_version,
                Kind = data.Confluent_flink_region.Example.Kind,
                Environment = new ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironmentArgs
                {
                    Id = confluent_environment.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()        
                .description("Flink API Key that is owned by 'env-manager' service account")
                .owner(ApiKeyOwnerArgs.builder()
                    .id(confluent_service_account.env-manager().id())
                    .apiVersion(confluent_service_account.env-manager().api_version())
                    .kind(confluent_service_account.env-manager().kind())
                    .build())
                .managedResource(ApiKeyManagedResourceArgs.builder()
                    .id(data.confluent_flink_region().example().id())
                    .apiVersion(data.confluent_flink_region().example().api_version())
                    .kind(data.confluent_flink_region().example().kind())
                    .environment(ApiKeyManagedResourceEnvironmentArgs.builder()
                        .id(confluent_environment.staging().id())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      env-manager-flink-api-key:
        type: confluentcloud:ApiKey
        properties:
          description: Flink API Key that is owned by 'env-manager' service account
          owner:
            id: ${confluent_service_account"env-manager"[%!s(MISSING)].id}
            apiVersion: ${confluent_service_account"env-manager"[%!s(MISSING)].api_version}
            kind: ${confluent_service_account"env-manager"[%!s(MISSING)].kind}
          managedResource:
            id: ${data.confluent_flink_region.example.id}
            apiVersion: ${data.confluent_flink_region.example.api_version}
            kind: ${data.confluent_flink_region.example.kind}
            environment:
              id: ${confluent_environment.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", {
        description: "Cloud API Key that is owned by 'env-manager' service account",
        owner: {
            id: confluent_service_account["env-manager"].id,
            apiVersion: confluent_service_account["env-manager"].api_version,
            kind: confluent_service_account["env-manager"].kind,
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    env_manager_cloud_api_key = confluentcloud.ApiKey("env-manager-cloud-api-key",
        description="Cloud API Key that is owned by 'env-manager' service account",
        owner=confluentcloud.ApiKeyOwnerArgs(
            id=confluent_service_account["env-manager"]["id"],
            api_version=confluent_service_account["env-manager"]["api_version"],
            kind=confluent_service_account["env-manager"]["kind"],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := confluentcloud.NewApiKey(ctx, "env-manager-cloud-api-key", &confluentcloud.ApiKeyArgs{
    			Description: pulumi.String("Cloud API Key that is owned by 'env-manager' service account"),
    			Owner: &confluentcloud.ApiKeyOwnerArgs{
    				Id:         pulumi.Any(confluent_service_account.EnvManager.Id),
    				ApiVersion: pulumi.Any(confluent_service_account.EnvManager.Api_version),
    				Kind:       pulumi.Any(confluent_service_account.EnvManager.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()
        {
            Description = "Cloud API Key that is owned by 'env-manager' service account",
            Owner = new ConfluentCloud.Inputs.ApiKeyOwnerArgs
            {
                Id = confluent_service_account.Env_manager.Id,
                ApiVersion = confluent_service_account.Env_manager.Api_version,
                Kind = confluent_service_account.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()        
                .description("Cloud API Key that is owned by 'env-manager' service account")
                .owner(ApiKeyOwnerArgs.builder()
                    .id(confluent_service_account.env-manager().id())
                    .apiVersion(confluent_service_account.env-manager().api_version())
                    .kind(confluent_service_account.env-manager().kind())
                    .build())
                .build());
    
        }
    }
    
    resources:
      env-manager-cloud-api-key:
        type: confluentcloud:ApiKey
        properties:
          description: Cloud API Key that is owned by 'env-manager' service account
          owner:
            id: ${confluent_service_account"env-manager"[%!s(MISSING)].id}
            apiVersion: ${confluent_service_account"env-manager"[%!s(MISSING)].api_version}
            kind: ${confluent_service_account"env-manager"[%!s(MISSING)].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 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 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.

    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=confluentcloud.ApiKeyOwnerArgs(
            api_version="string",
            id="string",
            kind="string",
        ),
        description="string",
        disable_wait_for_ready=False,
        display_name="string",
        managed_resource=confluentcloud.ApiKeyManagedResourceArgs(
            api_version="string",
            environment=confluentcloud.ApiKeyManagedResourceEnvironmentArgs(
                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

    The ApiKey resource accepts the following input properties:

    Owner 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 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 Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    Owner 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 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 ApiKeyManagedResourceArgs
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 ApiKeyManagedResourceArgs
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.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.
    disableWaitForReady 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 Property Map
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.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)
    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.
    The following state arguments are supported:
    Description string
    A free-form description of the API Account.
    DisableWaitForReady 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 Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    Owner 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 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 ApiKeyManagedResourceArgs
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    Owner 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 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 ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 ApiKeyManagedResource
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 ApiKeyManagedResourceArgs
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.Cluster'.
    owner 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 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 Property Map
    The resource associated with this object. The only resource that is supported is 'cmk.v2.Cluster', 'srcm.v2.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

    ApiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    Environment Pulumi.ConfluentCloud.Inputs.ApiKeyManagedResourceEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Id string
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    Kind string
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    ApiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    Environment ApiKeyManagedResourceEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Id string
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    Kind string
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion String
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    environment ApiKeyManagedResourceEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    id String
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    kind String
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    environment ApiKeyManagedResourceEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    id string
    The ID of the Environment that the managed resource belongs to, for example, env-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 ApiKeyManagedResourceEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    id str
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    kind str
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion 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 Environment that the managed resource belongs to, for example, env-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

    ApiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    Id string
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    Kind string
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    ApiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    Id string
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    Kind string
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion String
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    id String
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    kind String
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion string
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    id string
    The ID of the Environment that the managed resource belongs to, for example, env-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.
    id str
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    kind str
    The kind of the managed resource that the API Key associated with, for example, Cluster.
    apiVersion String
    The API group and version of the managed resource that the API Key associated with, for example, cmk/v2.
    id String
    The ID of the Environment that the managed resource belongs to, for example, env-abc123.
    kind String
    The kind of the managed resource that the API Key associated with, for example, Cluster.

    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.
    confluentcloud logo
    Confluent v1.41.0 published on Saturday, Apr 13, 2024 by Pulumi