gcloud managed-kafka connect-clusters create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud managed-kafka connect-clusters create - create a Managed Service for Apache Kafka connect cluster
- SYNOPSIS
gcloud managed-kafka connect-clusters create(CONNECT_CLUSTER:--location=LOCATION)--cpu=CPU--kafka-cluster=KAFKA_CLUSTER--memory=MEMORY--primary-subnet=PRIMARY_SUBNET[--additional-subnet=ADDITIONAL_SUBNET][--async][--dns-name=DNS_NAME][--labels=[KEY=VALUE,…]][--secret=SECRET][--config-file=JSON|YAML|FILE|--configs=[KEY=VALUE,…]][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Create a Managed Service for Apache Kafka connect cluster.
- EXAMPLES
- To create a connector cluster, run the following:
gcloudmanaged-kafkaconnect-clusterscreatemyconnectorCluster--location=us-central1--cpu=3--memory=3GiB--primary-subnet=projects/PROJECT_ID/regions/us-central1/subnetworks/default--kafka-cluster=my-kafka-clusterOR--kafka-cluster=projects/PROJECT_ID/locations/us-central1/clusters/my-kafka-cluster - POSITIONAL ARGUMENTS
- Connect cluster resource - Identifies the connect cluster that is created. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
To set the
projectattribute:- provide the argument
connect_clusteron the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CONNECT_CLUSTER- ID of the connect_cluster or fully qualified identifier for the connect_cluster.
To set the
connect_clusterattribute:- provide the argument
connect_clusteron the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- ID of the location of the Managed Service for Apache Kafka resource. Seehttps://cloud.google.com/managed-service-for-apache-kafka/docs/locationsfor a list of supported locations.To set the
locationattribute:- provide the argument
connect_clusteron the command line with afully specified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Connect cluster resource - Identifies the connect cluster that is created. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
- REQUIRED FLAGS
--cpu=CPU- The number of vCPUs to provision for the cluster. The minimum is 3.
--kafka-cluster=KAFKA_CLUSTER- The resource path of the Kafka cluster to connect to, or the name of the Kafkacluster to connect to if the cluster is in the same project as the Connectcluster.
--memory=MEMORY- The memory to provision for the cluster in bytes. The value must be between 1GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
--primary-subnet=PRIMARY_SUBNET- VPC subnet to make available to the Kafka Connect cluster. Structured like:projects/{project}/regions/{region}/subnetworks/{subnet_id}. The primary subnetis used to create a Private Service Connect (PSC) interface for the KafkaConnect workers. It must be located in the same region as the Connect cluster.
- OPTIONAL FLAGS
--additional-subnet=ADDITIONAL_SUBNET- (DEPRECATED) Additional subnet to make available to the Kafka Connect cluster.Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}.
The --additional-subnet flag is deprecated and will be removed in a futureversion. Managed Kafka Connect clusters can now reach any endpoint accessiblefrom the primary subnet without the need to define additional subnets. Pleaseseehttps://cloud.google.com/managed-service-for-apache-kafka/docs/connect-cluster/create-connect-cluster#worker-subnetfor more information.
--async- Return immediately, without waiting for the operation in progress to complete.
--dns-name=DNS_NAME- DNS domain name from the subnet's network to be made visible to the ConnectCluster.
--labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to add. Keys must start with a lowercase characterand contain only hyphens (
-), underscores (_),lowercase characters, and numbers. Values must contain only hyphens(-), underscores (_), lowercase characters, andnumbers. --secret=SECRET- Secrets to load into workers. Exact SecretVersions from Secret Manager must beprovided -- aliases are not supported. Up to 32 secrets may be loaded into onecluster. Format:projects/<project-id>/secrets/<secret-name>/versions/<version-id>
- At most one of these can be specified:
--config-file=JSON|YAML|FILE- The path to the JSON or YAML file containing the configuration that areoverridden from the cluster or connector defaults. This also supports inlineJSON or YAML. Sets
config_filevalue.Input Example:--config-file=stringFile Example:--config-file=path_to_file.(yaml|json)
--configs=[KEY=VALUE,…]- Configuration for the connect cluster that are overridden from the clusterdefaults. The key of the map is a Kafka topic property name, for example:
cleanup.policy=compact,compression.type=producer.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
managedkafka/v1API. The full documentationfor this API can be found at:https://cloud.google.com/managed-service-for-apache-kafka/docs - NOTES
- These variants are also available:
gcloudalphamanaged-kafkaconnect-clusterscreategcloudbetamanaged-kafkaconnect-clusterscreate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-09 UTC.