1. Packages
  2. Confluent Cloud
  3. API Docs
  4. KsqlCluster
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

confluentcloud.KsqlCluster

Explore with Pulumi AI

confluentcloud logo
Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

    Import

    You can import a ksqlDB cluster by using Environment ID and ksqlDB cluster ID, in the format <Environment ID>/<ksqlDB cluster ID>, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

     $ pulumi import confluentcloud:index/ksqlCluster:KsqlCluster example env-abc123/lksqlc-abc123
    

    !> Warning:

    Do not forget to delete the terminal’s command history afterward for security purposes.

    Create KsqlCluster Resource

    new KsqlCluster(name: string, args: KsqlClusterArgs, opts?: CustomResourceOptions);
    @overload
    def KsqlCluster(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    credential_identity: Optional[KsqlClusterCredentialIdentityArgs] = None,
                    csu: Optional[int] = None,
                    display_name: Optional[str] = None,
                    environment: Optional[KsqlClusterEnvironmentArgs] = None,
                    kafka_cluster: Optional[KsqlClusterKafkaClusterArgs] = None,
                    use_detailed_processing_log: Optional[bool] = None)
    @overload
    def KsqlCluster(resource_name: str,
                    args: KsqlClusterArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewKsqlCluster(ctx *Context, name string, args KsqlClusterArgs, opts ...ResourceOption) (*KsqlCluster, error)
    public KsqlCluster(string name, KsqlClusterArgs args, CustomResourceOptions? opts = null)
    public KsqlCluster(String name, KsqlClusterArgs args)
    public KsqlCluster(String name, KsqlClusterArgs args, CustomResourceOptions options)
    
    type: confluentcloud:KsqlCluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args KsqlClusterArgs
    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 KsqlClusterArgs
    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 KsqlClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KsqlClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KsqlClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    CredentialIdentity Pulumi.ConfluentCloud.Inputs.KsqlClusterCredentialIdentity
    Csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    DisplayName string

    The name of the ksqlDB cluster.

    Environment Pulumi.ConfluentCloud.Inputs.KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    KafkaCluster Pulumi.ConfluentCloud.Inputs.KsqlClusterKafkaCluster
    UseDetailedProcessingLog bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    CredentialIdentity KsqlClusterCredentialIdentityArgs
    Csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    DisplayName string

    The name of the ksqlDB cluster.

    Environment KsqlClusterEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    KafkaCluster KsqlClusterKafkaClusterArgs
    UseDetailedProcessingLog bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    credentialIdentity KsqlClusterCredentialIdentity
    csu Integer

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName String

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster KsqlClusterKafkaCluster
    useDetailedProcessingLog Boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    credentialIdentity KsqlClusterCredentialIdentity
    csu number

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName string

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster KsqlClusterKafkaCluster
    useDetailedProcessingLog boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    credential_identity KsqlClusterCredentialIdentityArgs
    csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    display_name str

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafka_cluster KsqlClusterKafkaClusterArgs
    use_detailed_processing_log bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    credentialIdentity Property Map
    csu Number

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName String

    The name of the ksqlDB cluster.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster Property Map
    useDetailedProcessingLog Boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    Outputs

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

    ApiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    Id string

    The provider-assigned unique ID for this managed resource.

    Kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    ResourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    RestEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    Storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    TopicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    ApiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    Id string

    The provider-assigned unique ID for this managed resource.

    Kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    ResourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    RestEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    Storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    TopicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    apiVersion String

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    id String

    The provider-assigned unique ID for this managed resource.

    kind String

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName String

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint String

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage Integer

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix String

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    apiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    id string

    The provider-assigned unique ID for this managed resource.

    kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage number

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    api_version str

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    id str

    The provider-assigned unique ID for this managed resource.

    kind str

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resource_name str

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    rest_endpoint str

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topic_prefix str

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    apiVersion String

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    id String

    The provider-assigned unique ID for this managed resource.

    kind String

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName String

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint String

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage Number

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix String

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    Look up Existing KsqlCluster Resource

    Get an existing KsqlCluster 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?: KsqlClusterState, opts?: CustomResourceOptions): KsqlCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_version: Optional[str] = None,
            credential_identity: Optional[KsqlClusterCredentialIdentityArgs] = None,
            csu: Optional[int] = None,
            display_name: Optional[str] = None,
            environment: Optional[KsqlClusterEnvironmentArgs] = None,
            kafka_cluster: Optional[KsqlClusterKafkaClusterArgs] = None,
            kind: Optional[str] = None,
            resource_name: Optional[str] = None,
            rest_endpoint: Optional[str] = None,
            storage: Optional[int] = None,
            topic_prefix: Optional[str] = None,
            use_detailed_processing_log: Optional[bool] = None) -> KsqlCluster
    func GetKsqlCluster(ctx *Context, name string, id IDInput, state *KsqlClusterState, opts ...ResourceOption) (*KsqlCluster, error)
    public static KsqlCluster Get(string name, Input<string> id, KsqlClusterState? state, CustomResourceOptions? opts = null)
    public static KsqlCluster get(String name, Output<String> id, KsqlClusterState 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:
    ApiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    CredentialIdentity Pulumi.ConfluentCloud.Inputs.KsqlClusterCredentialIdentity
    Csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    DisplayName string

    The name of the ksqlDB cluster.

    Environment Pulumi.ConfluentCloud.Inputs.KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    KafkaCluster Pulumi.ConfluentCloud.Inputs.KsqlClusterKafkaCluster
    Kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    ResourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    RestEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    Storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    TopicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    UseDetailedProcessingLog bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    ApiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    CredentialIdentity KsqlClusterCredentialIdentityArgs
    Csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    DisplayName string

    The name of the ksqlDB cluster.

    Environment KsqlClusterEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    KafkaCluster KsqlClusterKafkaClusterArgs
    Kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    ResourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    RestEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    Storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    TopicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    UseDetailedProcessingLog bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    apiVersion String

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    credentialIdentity KsqlClusterCredentialIdentity
    csu Integer

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName String

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster KsqlClusterKafkaCluster
    kind String

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName String

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint String

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage Integer

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix String

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    useDetailedProcessingLog Boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    apiVersion string

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    credentialIdentity KsqlClusterCredentialIdentity
    csu number

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName string

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironment

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster KsqlClusterKafkaCluster
    kind string

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName string

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint string

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage number

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix string

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    useDetailedProcessingLog boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    api_version str

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    credential_identity KsqlClusterCredentialIdentityArgs
    csu int

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    display_name str

    The name of the ksqlDB cluster.

    environment KsqlClusterEnvironmentArgs

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafka_cluster KsqlClusterKafkaClusterArgs
    kind str

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resource_name str

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    rest_endpoint str

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage int

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topic_prefix str

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    use_detailed_processing_log bool

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    apiVersion String

    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

    credentialIdentity Property Map
    csu Number

    The number of Confluent Streaming Units (CSUs) for the ksqlDB cluster.

    displayName String

    The name of the ksqlDB cluster.

    environment Property Map

    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.

    kafkaCluster Property Map
    kind String

    (Required String) A kind of the ksqlDB cluster, for example, Cluster.

    resourceName String

    (Required String) The Confluent Resource Name of the ksqlDB cluster.

    restEndpoint String

    (Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

    storage Number

    (Required Integer) The amount of storage (in GB) provisioned to the ksqlDB cluster.

    topicPrefix String

    (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example, pksqlc-00000.

    useDetailedProcessingLog Boolean

    Controls whether the row data should be included in the processing log topic. Set it to false if you don't want to emit sensitive information to the processing log. Defaults to true.

    Supporting Types

    KsqlClusterCredentialIdentity, KsqlClusterCredentialIdentityArgs

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-abc123.

    id string

    The ID of the associated service or user account, for example, sa-abc123.

    id str

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-abc123.

    KsqlClusterEnvironment, KsqlClusterEnvironmentArgs

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-abc123.

    id string

    The ID of the associated service or user account, for example, sa-abc123.

    id str

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-abc123.

    KsqlClusterKafkaCluster, KsqlClusterKafkaClusterArgs

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    Id string

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-abc123.

    id string

    The ID of the associated service or user account, for example, sa-abc123.

    id str

    The ID of the associated service or user account, for example, sa-abc123.

    id String

    The ID of the associated service or user account, for example, sa-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.26.0 published on Thursday, Sep 28, 2023 by Pulumi