# Confluent Terraform Provider for Confluent Cloud The Confluent Terraform provider lets you manage Confluent Cloud infrastructure as code. Use it to create and configure resources such as environments, Apache Kafka® clusters, topics, schemas, ACLs, role-based access control (RBAC) roles, networking, and connectors, all from declarative [Terraform](https://developer.hashicorp.com/terraform/docs) configuration files. ## Why use the Confluent Terraform provider Use the Confluent Terraform provider to manage Confluent Cloud infrastructure as code, so you can version, review, and reproduce your environments using the same workflow you use for application code. The provider automates provisioning for environments, Kafka clusters, Kafka topics, and other Confluent Cloud resources. These are some of the benefits you get with the Confluent Terraform provider: - **Human-readable configuration:** Define infrastructure resources declaratively in human-readable configuration files. - **Comprehensive resource coverage:** Manage Confluent Cloud resources such as API keys, environments, Kafka clusters, topics, ACLs, RBAC, and private networking. - **Consistent deployability:** Provision and manage your infrastructure safely and efficiently throughout its lifecycle. Package reusable modules to provision multi-cloud resources. - **Multi-cloud with ease:** Deploy Confluent Cloud seamlessly across cloud providers. - **Scale quickly:** Provision complex and dependent infrastructure quickly. - **Industry standard:** Enable industry-standard GitOps and infrastructure-as-code practices. The Confluent Terraform provider plugin is available on the [Terraform Registry](https://registry.terraform.io/providers/confluentinc/confluent/latest). ## What you can manage with the provider - [Confluent](#confluent-terraform-provider-resources-confluent): Invitations and provider integrations - [Confluent Intelligence](#confluent-terraform-provider-resources-confluent-intelligence): Real-Time Context Engine topics - [Connect](#confluent-terraform-provider-resources-connect): Connectors, connector plugins, and custom connector artifacts - [Confluent Cloud for Apache Flink®](#confluent-terraform-provider-resources-flink): Compute pools, Flink statements, and Flink connections - [Apache Kafka®](#confluent-terraform-provider-resources-kafka): Clusters, topics, mirror topics, cluster links, and client quotas - [ksqlDB](#confluent-terraform-provider-resources-ksqldb): ksqlDB clusters - [Metadata](#confluent-terraform-provider-resources-metadata): Schemas, schema registries, tags, and business metadata - [Network](#confluent-terraform-provider-resources-network): Networks, peering, PrivateLink, Transit Gateway, DNS, and IP filters - [Schema management and Stream Governance](#confluent-terraform-provider-resources-schema): Schemas, schema registry clusters, subjects, and exporters - [Security, access control, and identity](#confluent-terraform-provider-resources-security): API keys, BYOK keys, environments, identity pools and providers, ACLs, role bindings, and service accounts - [Tableflow](#confluent-terraform-provider-resources-tableflow): Tableflow topics and catalog integrations ## Tutorials and sample projects The following resources show how to get started with the Confluent Terraform provider. For realistic examples that create multiple Confluent Cloud resources, see the [Sample Project for Confluent Terraform Provider](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/guides/sample-project). The sample project shows configurations that provision Confluent Cloud resources like these: - Basic, Standard, Enterprise, Dedicated, and Freight Kafka clusters - PrivateLink connections - RBAC and ACLs for access control - Source and sink connectors - VPC Peering connections For a guided walkthrough, see [Applying Data Pipeline Principles in Practice: Exploring the Kafka Summit Keynote Demo](https://www.confluent.io/blog/data-pipeline-principles-use-cases-examples/). ## Using the Confluent Terraform provider To use the Confluent Terraform provider, declare it in the `required_providers` block, configure your Confluent Cloud API key credentials, and define resources in a Terraform configuration file. The following example provisions a Confluent Cloud environment, a basic Kafka cluster, and a service account: ```terraform # Configure the Confluent Provider terraform { required_providers { confluent = { source = "confluentinc/confluent" version = "2.76.0" } } } provider "confluent" { cloud_api_key = var.confluent_cloud_api_key # optionally use CONFLUENT_CLOUD_API_KEY env var cloud_api_secret = var.confluent_cloud_api_secret # optionally use CONFLUENT_CLOUD_API_SECRET env var } resource "confluent_environment" "development" { display_name = "Development" lifecycle { prevent_destroy = true } } resource "confluent_kafka_cluster" "basic" { display_name = "basic_kafka_cluster" availability = "SINGLE_ZONE" cloud = "AWS" region = "us-east-2" basic {} environment { id = confluent_environment.development.id } lifecycle { prevent_destroy = true } } resource "confluent_service_account" "app-manager" { display_name = "app-manager" description = "Service account to manage Kafka cluster" } # Create more resources ... ``` You must provide appropriate Confluent Cloud and Kafka cluster credentials to use the provider. For more information about the resources that you can interact with, see the [Confluent Terraform Provider documentation](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs) in the Terraform registry. ## Tools and resources Find the provider source code and example configurations, and import your existing Confluent Cloud infrastructure into Terraform. ### Source code The Confluent Terraform provider is open source. The provider code and example configurations are in two Confluent GitHub repositories. - For the provider source code, see the [Confluent Terraform Provider repository on GitHub](https://github.com/confluentinc/terraform-provider-confluent). - For sample configuration files, see the [examples](https://github.com/confluentinc/terraform-provider-confluent/tree/master/examples/configurations) directory in the source repo. ### Import existing Confluent Cloud resources to Terraform To import your existing Confluent Cloud resources into Terraform configuration (`main.tf`) and Terraform state (`terraform.tfstate`) files, use the [confluent_tf_importer](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_tf_importer) resource. For step-by-step instructions, see the [Resource Importer](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/guides/resource-importer) guide. ## Resources you can manage You can provision the following Confluent Cloud resources and get data from these data sources in your Terraform configuration files. ### Confluent | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [Confluent Invitation](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_invitation) | [Confluent Invitation](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_invitation) | | [Confluent Provider Integration](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_provider_integration) | [Confluent Provider Integration](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_provider_integration) | | – | [Confluent Endpoint](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_endpoint) | | – | [Confluent Gateways](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_gateways) | ### Confluent Intelligence | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [Confluent Real-Time Context Engine Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_rtce_topic) | [Confluent Real-Time Context Engine Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_rtce_topic) | ### Connect | Resource | Data Source | |------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| | [Connect Artifact](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_connect_artifact) | [Connect Artifact](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_connect_artifact) | | [Connector](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_connector) | – | | [Connector Plugin](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_plugin) | – | | [Connector Plugin Version](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_custom_connector_plugin_version) | – | ### Flink | Resource | Data Source | |-----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | [Flink Artifact](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_flink_artifact) | [Flink Artifact](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_flink_artifact) | | [Flink Compute Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_flink_compute_pool) | [Flink Compute Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_flink_compute_pool) | | [Flink Connection](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_flink_connection) | [Flink Connection](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_flink_connection) | | [Flink Statement](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_flink_statement) | – | | – | [Flink Region](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_flink_region) | ### Kafka cluster | Resource | Data Source | |--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | [Cluster Link](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_cluster_link) | [Cluster Link](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_cluster_link) | | [Connector](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_connector) | – | | [Dedicated Kafka Cluster Configuration](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_cluster_config) | – | | [Kafka Client Quota](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_client_quota) | [Kafka Client Quota](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_kafka_client_quota) | | [Kafka Cluster](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_cluster) | [Kafka Cluster](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_kafka_cluster) | | – | [Kafka Clusters](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_kafka_clusters) | | [Kafka Mirror Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_mirror_topic) | – | | [Kafka Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_topic) | [Kafka Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_kafka_topic) | ### ksqlDB | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| | [ksqlDB Cluster](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_ksql_cluster) | [ksqlDB Cluster](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_ksql_cluster) | ### Metadata | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [Business Metadata](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_business_metadata) | [Business Metadata](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_business_metadata) | | [Business Metadata Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_business_metadata_binding) | [Business Metadata Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_business_metadata_binding) | | [Tag](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_tag) | [Tag](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_tag) | | [Tag Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_tag) | [Tag Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_tag_binding) | ### Network | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Access Point](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_access_point) | [Access Point](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_access_point) | | [Certificate Authority](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_certificate_authority) | [Certificate Authority](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_certificate_authority) | | [Certificate Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_certificate_pool) | [Certificate Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_certificate_pool) | | [DNS Record](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_dns_record) | [DNS Record](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_dns_record) | | – | [IP Addresses (Preview)](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_ip_addresses) | | [DNS Forwarder](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_dns_forwarder) | – | | [Gateway](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_gateway) | [Gateway](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_gateway) | | [IP Filter](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_ip_filter) | [IP Filter](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_ip_filter) | | [IP Group](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_ip_group) | [IP Group](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_ip_group) | | [Network](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_network) | [Network](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_network) | | [Network Link Endpoint](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_network_link_endpoint) | [Network Link Endpoint](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_network_link_endpoint) | | [Network Link Service](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_network_link_service) | [Network Link Service](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_network_link_service) | | [Peering](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_peering) | [Peering](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_peering) | | [Private Link Access](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_private_link_access) | [Private Link Access](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_private_link_access) | | [Private Link Attachment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_private_link_attachment) | [Private Link Attachment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_private_link_attachment) | | [Private Link Attachment Connection](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_private_link_attachment_connection) | [Private Link Attachment Connection](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_private_link_attachment_connection) | | [Transit Gateway Attachment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_transit_gateway_attachment) | [Transit Gateway Attachment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_transit_gateway_attachment) | ### Schema management and Stream Governance | Resource | Data Source | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Catalog Entity Attributes](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_catalog_entity_attributes) | – | | [Schema](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema) | [Schema](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema) | | – | [Schemas](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schemas) | | [Schema Exporter](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema_exporter) | – | | – | [Schema Registry Cluster](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_cluster) | | – | [Schema Registry Clusters](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_clusters) | | [Schema Registry Cluster Config](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema_registry_cluster_config) | [Schema Registry Cluster Config](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_cluster_config) | | [Schema Registry Cluster Mode](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema_registry_cluster_mode) | [Schema Registry Cluster Mode](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_cluster_mode) | | [Schema Registry DEK](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema_registry_dek) | [Schema Registry DEK](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_dek) | | [Schema Registry KEK](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_schema_registry_kek) | [Schema Registry KEK](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_schema_registry_kek) | | [Subject Config](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_subject_config) | [Subject Config](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_subject_config) | | [Subject Mode](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_subject_mode) | [Subject Mode](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_subject_mode) | ### Security, access control, and identity | Resource | Data Source | |---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| | [API key](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_api_key) | – | | [BYOK key](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_byok_key) | [BYOK key](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_byok_key) | | [Environment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_environment) | [Environment](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_environment) | | – | [Environments](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_environments) | | [Group Mapping](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_group_mapping) | [Group Mapping](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_group_mapping) | | [Identity Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_identity_pool) | [Identity Pool](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_identity_pool) | | [Identity Provider](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_identity_provider) | [Identity Provider](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_identity_provider) | | [Kafka ACL](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_kafka_acl) | – | | – | [Organization](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_organization) | | [Role Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_role_binding) | [Role Binding](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_role_binding) | | [Service Account](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_service_account) | [Service Account](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_service_account) | | – | [User](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_user) | | – | [Users](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_users) | ### Tableflow | Resource | Data Source | |-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| | [Tableflow Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_tableflow_topic) | [Tableflow Topic](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_tableflow_topic) | | [Catalog Integration](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/resources/confluent_catalog_integration) | [Catalog Integration](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs/data-sources/confluent_catalog_integration) | ## Related content - [Video: Getting started with the Confluent Terraform Provider](https://www.youtube.com/watch?v=ofSQ4j9u6W4) - [Terraform CLI Documentation](https://www.terraform.io/cli) - [Terraform Security Best Practices for Confluent Cloud](terraform-security.md#terraform-security-best-practices) - [Confluent Cloud Provider for Pulumi](pulumi-provider.md#confluent-pulumi-provider) - [Kafka Cluster Types in Confluent Cloud](cluster-types.md#cloud-cluster-types)