Docs Packages
  1. Packages
  2. Confluent Cloud
  3. API Docs
  4. KafkaClusterConfig
Confluent v1.48.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.KafkaClusterConfig

Explore with Pulumi AI

confluentcloud logo
Confluent v1.48.0 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-confluentcloud

    Import

    You can import a Kafka cluster config by using the Kafka cluster ID, for example:

    Option #1: Manage multiple Kafka clusters in the same Terraform workspace

    $ export IMPORT_KAFKA_API_KEY="<kafka_api_key>"

    $ export IMPORT_KAFKA_API_SECRET="<kafka_api_secret>"

    $ export IMPORT_KAFKA_REST_ENDPOINT="<kafka_rest_endpoint>"

    $ pulumi import confluentcloud:index/kafkaClusterConfig:KafkaClusterConfig test lkc-abc123

    Option #2: Manage a single Kafka cluster in the same Terraform workspace

    $ pulumi import confluentcloud:index/kafkaClusterConfig:KafkaClusterConfig test lkc-abc123

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

    Create KafkaClusterConfig Resource

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

    Constructor syntax

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

@overload
def KafkaClusterConfig(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       config: Optional[Mapping[str, str]] = None,
                       credentials: Optional[KafkaClusterConfigCredentialsArgs] = None,
                       kafka_cluster: Optional[KafkaClusterConfigKafkaClusterArgs] = None,
                       rest_endpoint: Optional[str] = None)
    func NewKafkaClusterConfig(ctx *Context, name string, args KafkaClusterConfigArgs, opts ...ResourceOption) (*KafkaClusterConfig, error)
    public KafkaClusterConfig(string name, KafkaClusterConfigArgs args, CustomResourceOptions? opts = null)
    public KafkaClusterConfig(String name, KafkaClusterConfigArgs args)
public KafkaClusterConfig(String name, KafkaClusterConfigArgs args, CustomResourceOptions options)

    type: confluentcloud:KafkaClusterConfig
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 KafkaClusterConfigArgs
    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 KafkaClusterConfigArgs
    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 KafkaClusterConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaClusterConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaClusterConfigArgs
    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 kafkaClusterConfigResource = new ConfluentCloud.KafkaClusterConfig("kafkaClusterConfigResource", new()
{
    Config = 
    {
        { "string", "string" },
    },
    Credentials = new ConfluentCloud.Inputs.KafkaClusterConfigCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    KafkaCluster = new ConfluentCloud.Inputs.KafkaClusterConfigKafkaClusterArgs
    {
        Id = "string",
    },
    RestEndpoint = "string",
});

    example, err := confluentcloud.NewKafkaClusterConfig(ctx, "kafkaClusterConfigResource", &confluentcloud.KafkaClusterConfigArgs{
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Credentials: &confluentcloud.KafkaClusterConfigCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	KafkaCluster: &confluentcloud.KafkaClusterConfigKafkaClusterArgs{
		Id: pulumi.String("string"),
	},
	RestEndpoint: pulumi.String("string"),
})

    var kafkaClusterConfigResource = new KafkaClusterConfig("kafkaClusterConfigResource", KafkaClusterConfigArgs.builder()
    .config(Map.of("string", "string"))
    .credentials(KafkaClusterConfigCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .kafkaCluster(KafkaClusterConfigKafkaClusterArgs.builder()
        .id("string")
        .build())
    .restEndpoint("string")
    .build());

    kafka_cluster_config_resource = confluentcloud.KafkaClusterConfig("kafkaClusterConfigResource",
    config={
        "string": "string",
    },
    credentials=confluentcloud.KafkaClusterConfigCredentialsArgs(
        key="string",
        secret="string",
    ),
    kafka_cluster=confluentcloud.KafkaClusterConfigKafkaClusterArgs(
        id="string",
    ),
    rest_endpoint="string")

    const kafkaClusterConfigResource = new confluentcloud.KafkaClusterConfig("kafkaClusterConfigResource", {
    config: {
        string: "string",
    },
    credentials: {
        key: "string",
        secret: "string",
    },
    kafkaCluster: {
        id: "string",
    },
    restEndpoint: "string",
});

    type: confluentcloud:KafkaClusterConfig
properties:
    config:
        string: string
    credentials:
        key: string
        secret: string
    kafkaCluster:
        id: string
    restEndpoint: string

    KafkaClusterConfig 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 KafkaClusterConfig resource accepts the following input properties:

    Config Dictionary<string, string>
    The custom cluster settings to set:
    Credentials Pulumi.ConfluentCloud.Inputs.KafkaClusterConfigCredentials
    The Cluster API Credentials.
    KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaClusterConfigKafkaCluster
    RestEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    Config map[string]string
    The custom cluster settings to set:
    Credentials KafkaClusterConfigCredentialsArgs
    The Cluster API Credentials.
    KafkaCluster KafkaClusterConfigKafkaClusterArgs
    RestEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Map<String,String>
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentials
    The Cluster API Credentials.
    kafkaCluster KafkaClusterConfigKafkaCluster
    restEndpoint String
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config {[key: string]: string}
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentials
    The Cluster API Credentials.
    kafkaCluster KafkaClusterConfigKafkaCluster
    restEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Mapping[str, str]
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentialsArgs
    The Cluster API Credentials.
    kafka_cluster KafkaClusterConfigKafkaClusterArgs
    rest_endpoint str
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Map<String>
    The custom cluster settings to set:
    credentials Property Map
    The Cluster API Credentials.
    kafkaCluster Property Map
    restEndpoint String
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KafkaClusterConfig Resource

    Get an existing KafkaClusterConfig 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?: KafkaClusterConfigState, opts?: CustomResourceOptions): KafkaClusterConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        credentials: Optional[KafkaClusterConfigCredentialsArgs] = None,
        kafka_cluster: Optional[KafkaClusterConfigKafkaClusterArgs] = None,
        rest_endpoint: Optional[str] = None) -> KafkaClusterConfig
    func GetKafkaClusterConfig(ctx *Context, name string, id IDInput, state *KafkaClusterConfigState, opts ...ResourceOption) (*KafkaClusterConfig, error)
    public static KafkaClusterConfig Get(string name, Input<string> id, KafkaClusterConfigState? state, CustomResourceOptions? opts = null)
    public static KafkaClusterConfig get(String name, Output<String> id, KafkaClusterConfigState 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:
    Config Dictionary<string, string>
    The custom cluster settings to set:
    Credentials Pulumi.ConfluentCloud.Inputs.KafkaClusterConfigCredentials
    The Cluster API Credentials.
    KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaClusterConfigKafkaCluster
    RestEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    Config map[string]string
    The custom cluster settings to set:
    Credentials KafkaClusterConfigCredentialsArgs
    The Cluster API Credentials.
    KafkaCluster KafkaClusterConfigKafkaClusterArgs
    RestEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Map<String,String>
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentials
    The Cluster API Credentials.
    kafkaCluster KafkaClusterConfigKafkaCluster
    restEndpoint String
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config {[key: string]: string}
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentials
    The Cluster API Credentials.
    kafkaCluster KafkaClusterConfigKafkaCluster
    restEndpoint string
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Mapping[str, str]
    The custom cluster settings to set:
    credentials KafkaClusterConfigCredentialsArgs
    The Cluster API Credentials.
    kafka_cluster KafkaClusterConfigKafkaClusterArgs
    rest_endpoint str
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    config Map<String>
    The custom cluster settings to set:
    credentials Property Map
    The Cluster API Credentials.
    kafkaCluster Property Map
    restEndpoint String
    The REST endpoint of the Dedicated Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

    Supporting Types

    KafkaClusterConfigCredentials, KafkaClusterConfigCredentialsArgs

    Key string
    The Kafka API Key.
    Secret string

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Key string
    The Kafka API Key.
    Secret string

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    key String
    The Kafka API Key.
    secret String

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    key string
    The Kafka API Key.
    secret string

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    key str
    The Kafka API Key.
    secret str

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    key String
    The Kafka API Key.
    secret String

    The Kafka API Secret.

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_cluster_config.orders", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    KafkaClusterConfigKafkaCluster, KafkaClusterConfigKafkaClusterArgs

    Id string
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.
    Id string
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.
    id string
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.
    id str
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Dedicated Kafka cluster, for example, lkc-abc123.

    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.48.0 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-confluentcloud