confluentcloud.KafkaCluster
Import
You can import a Kafka cluster by using Environment ID and Kafka cluster ID, in the format <Environment ID>/<Kafka cluster ID>
, e.g. $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/kafkaCluster:KafkaCluster my_kafka env-abc123/lkc-abc123
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
Create KafkaCluster Resource
new KafkaCluster(name: string, args: KafkaClusterArgs, opts?: CustomResourceOptions);
@overload
def KafkaCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
availability: Optional[str] = None,
basic: Optional[KafkaClusterBasicArgs] = None,
cloud: Optional[str] = None,
dedicated: Optional[KafkaClusterDedicatedArgs] = None,
display_name: Optional[str] = None,
environment: Optional[KafkaClusterEnvironmentArgs] = None,
network: Optional[KafkaClusterNetworkArgs] = None,
region: Optional[str] = None,
standard: Optional[KafkaClusterStandardArgs] = None)
@overload
def KafkaCluster(resource_name: str,
args: KafkaClusterArgs,
opts: Optional[ResourceOptions] = None)
func NewKafkaCluster(ctx *Context, name string, args KafkaClusterArgs, opts ...ResourceOption) (*KafkaCluster, error)
public KafkaCluster(string name, KafkaClusterArgs args, CustomResourceOptions? opts = null)
public KafkaCluster(String name, KafkaClusterArgs args)
public KafkaCluster(String name, KafkaClusterArgs args, CustomResourceOptions options)
type: confluentcloud:KafkaCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaClusterArgs
- 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 KafkaClusterArgs
- 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 KafkaClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KafkaClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
KafkaCluster 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 KafkaCluster resource accepts the following input properties:
- Availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- Cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Environment
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- Basic
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Basic Args The configuration of the Basic Kafka cluster.
- Dedicated
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Dedicated Args - Display
Name string The name of the Kafka cluster.
- Network
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Standard
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Standard Args The configuration of the Standard Kafka cluster.
- Availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- Cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- Basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- Dedicated
Kafka
Cluster Dedicated Args - Display
Name string The name of the Kafka cluster.
- Network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- availability String
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- cloud String
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region String
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- dedicated
Kafka
Cluster Dedicated Args - display
Name String The name of the Kafka cluster.
- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- dedicated
Kafka
Cluster Dedicated Args - display
Name string The name of the Kafka cluster.
- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- availability str
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- cloud str
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region str
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- dedicated
Kafka
Cluster Dedicated Args - display_
name str The name of the Kafka cluster.
- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- availability String
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- cloud String
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- environment Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- region String
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- basic Property Map
The configuration of the Basic Kafka cluster.
- dedicated Property Map
- display
Name String The name of the Kafka cluster.
- network Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- standard Property Map
The configuration of the Standard Kafka cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the KafkaCluster resource produces the following output properties:
- Api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- Bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- Rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
- Api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- Bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- Id string
The provider-assigned unique ID for this managed resource.
- Kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- Rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
- api
Version String (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- bootstrap
Endpoint String (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- id String
The provider-assigned unique ID for this managed resource.
- kind String
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- rbac
Crn String (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- rest
Endpoint String (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
- api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- id string
The provider-assigned unique ID for this managed resource.
- kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
- api_
version str (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- bootstrap_
endpoint str (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- id str
The provider-assigned unique ID for this managed resource.
- kind str
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- rbac_
crn str (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- rest_
endpoint str (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
- api
Version String (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- bootstrap
Endpoint String (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- id String
The provider-assigned unique ID for this managed resource.
- kind String
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- rbac
Crn String (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- rest
Endpoint String (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).
Look up Existing KafkaCluster Resource
Get an existing KafkaCluster 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?: KafkaClusterState, opts?: CustomResourceOptions): KafkaCluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_version: Optional[str] = None,
availability: Optional[str] = None,
basic: Optional[KafkaClusterBasicArgs] = None,
bootstrap_endpoint: Optional[str] = None,
cloud: Optional[str] = None,
dedicated: Optional[KafkaClusterDedicatedArgs] = None,
display_name: Optional[str] = None,
environment: Optional[KafkaClusterEnvironmentArgs] = None,
kind: Optional[str] = None,
network: Optional[KafkaClusterNetworkArgs] = None,
rbac_crn: Optional[str] = None,
region: Optional[str] = None,
rest_endpoint: Optional[str] = None,
standard: Optional[KafkaClusterStandardArgs] = None) -> KafkaCluster
func GetKafkaCluster(ctx *Context, name string, id IDInput, state *KafkaClusterState, opts ...ResourceOption) (*KafkaCluster, error)
public static KafkaCluster Get(string name, Input<string> id, KafkaClusterState? state, CustomResourceOptions? opts = null)
public static KafkaCluster get(String name, Output<String> id, KafkaClusterState 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.
- Api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- Availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- Basic
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Basic Args The configuration of the Basic Kafka cluster.
- Bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- Cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Dedicated
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Dedicated Args - Display
Name string The name of the Kafka cluster.
- Environment
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- Network
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- Region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- Standard
Pulumi.
Confluent Cloud. Inputs. Kafka Cluster Standard Args The configuration of the Standard Kafka cluster.
- Api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- Availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- Basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- Bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- Cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Dedicated
Kafka
Cluster Dedicated Args - Display
Name string The name of the Kafka cluster.
- Environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- Kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- Network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- Rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- Region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- Standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- api
Version String (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- availability String
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- bootstrap
Endpoint String (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- cloud String
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- dedicated
Kafka
Cluster Dedicated Args - display
Name String The name of the Kafka cluster.
- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind String
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- rbac
Crn String (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- region String
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- rest
Endpoint String (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- api
Version string (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- availability string
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- bootstrap
Endpoint string (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- cloud string
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- dedicated
Kafka
Cluster Dedicated Args - display
Name string The name of the Kafka cluster.
- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind string
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- rbac
Crn string (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- region string
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- api_
version str (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- availability str
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- basic
Kafka
Cluster Basic Args The configuration of the Basic Kafka cluster.
- bootstrap_
endpoint str (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- cloud str
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- dedicated
Kafka
Cluster Dedicated Args - display_
name str The name of the Kafka cluster.
- environment
Kafka
Cluster Environment Args Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind str
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- network
Kafka
Cluster Network Args Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- rbac_
crn str (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- region str
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- rest_
endpoint str (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- standard
Kafka
Cluster Standard Args The configuration of the Standard Kafka cluster.
- api
Version String (Required String) An API Version of the schema version of the Kafka cluster, for example,
cmk/v2
.- availability String
The availability zone configuration of the Kafka cluster. Accepted values are:
SINGLE_ZONE
andMULTI_ZONE
.- basic Property Map
The configuration of the Basic Kafka cluster.
- bootstrap
Endpoint String (Required String) The bootstrap endpoint used by Kafka clients to connect to the Kafka cluster. (e.g.,
SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092
).- cloud String
The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- dedicated Property Map
- display
Name String The name of the Kafka cluster.
- environment Property Map
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- kind String
(Required String) A kind of the Kafka cluster, for example,
Cluster
.- network Property Map
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts.
- rbac
Crn String (Required String) The Confluent Resource Name of the Kafka cluster, for example,
crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123
.- region String
The cloud service provider region where the Kafka cluster is running, for example,
us-west-2
. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.- rest
Endpoint String (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- standard Property Map
The configuration of the Standard Kafka cluster.
Supporting Types
KafkaClusterDedicated
- Cku int
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- Encryption
Key string The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
- Cku int
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- Encryption
Key string The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
- cku Integer
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key String The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
- cku number
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key string The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
- cku int
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption_
key str The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
- cku Number
The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for
SINGLE_ZONE
dedicated clusters is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key String The ID of the encryption key that is used to encrypt the data in the Kafka cluster, for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
(key Amazon Resource Name) for AWS orprojects/my-test-project/locations/global/keyRings/test-byok/cryptoKeys/test
for GCP. Append required permissions to the key policy before creating a Kafka cluster, see Encrypt Confluent Cloud Clusters using Self-Managed Keys for more details. At the moment, self-managed encryption keys are only available for the Dedicated clusters on AWS or GCP.
KafkaClusterEnvironment
- Id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- Id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id str
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
KafkaClusterNetwork
- Id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- Id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id string
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id str
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
- id String
The ID of the Network that the Kafka cluster belongs to, for example,
n-abc123
.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.