Skip to main content

@swamp/gcp/managedkafka

v2026.04.23.1

Google Cloud managedkafka infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudmanagedkafkacloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/managedkafka

@swamp/gcp/managedkafka/clustersv2026.04.23.1clusters.ts

Global Arguments

ArgumentTypeDescription
capacityConfig?objectA capacity configuration of a Kafka cluster.
gcpConfig?objectConfiguration properties for a Kafka cluster deployed to Google Cloud Platform.
labels?recordOptional. Labels as key value pairs.
name?stringIdentifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
rebalanceConfig?objectDefines rebalancing behavior of a Kafka cluster.
tlsConfig?objectThe TLS configuration for the Kafka cluster.
updateOptions?objectUpdateOptions specifies options that influence how a cluster update is applied. These options control the behavior of the update process, rather than defining the desired end-state of a cluster.
clusterId?stringRequired. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a clusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
updateUpdate clusters attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
syncSync clusters state from GCP

Resources

state(infinite)— An Apache Kafka cluster deployed in a location.
@swamp/gcp/managedkafka/clusters-aclsv2026.04.23.1clusters_acls.ts

Global Arguments

ArgumentTypeDescription
aclEntries?arrayRequired. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.
name?stringIdentifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following: For acls on the cluster: `cluster` For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}` F
aclId?stringRequired. The ID to use for the acl, which will become the final component of the acl\
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a acls
getGet a acls
ArgumentTypeDescription
identifierstringThe name of the acls
updateUpdate acls attributes
deleteDelete the acls
ArgumentTypeDescription
identifierstringThe name of the acls
syncSync acls state from GCP
add_acl_entryadd acl entry
ArgumentTypeDescription
host?any
operation?any
permissionType?any
principal?any

Resources

state(infinite)— Represents the set of ACLs for a given Kafka Resource Pattern, which consists...
@swamp/gcp/managedkafka/clusters-consumergroupsv2026.04.23.1clusters_consumergroups.ts

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
topics?recordOptional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a consumerGroups
ArgumentTypeDescription
identifierstringThe name of the consumerGroups
updateUpdate consumerGroups attributes
deleteDelete the consumerGroups
ArgumentTypeDescription
identifierstringThe name of the consumerGroups
syncSync consumerGroups state from GCP

Resources

state(infinite)— A Kafka consumer group in a given cluster.
@swamp/gcp/managedkafka/clusters-topicsv2026.04.23.1clusters_topics.ts

Global Arguments

ArgumentTypeDescription
configs?recordOptional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: `cleanup.policy`, `compression.type`.
name?stringIdentifier. The name of the topic. The `topic` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
partitionCount?numberRequired. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected.
replicationFactor?numberRequired. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
topicId?stringRequired. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a topics
getGet a topics
ArgumentTypeDescription
identifierstringThe name of the topics
updateUpdate topics attributes
deleteDelete the topics
ArgumentTypeDescription
identifierstringThe name of the topics
syncSync topics state from GCP

Resources

state(infinite)— A Kafka topic in a given cluster.
@swamp/gcp/managedkafka/connectclustersv2026.04.23.1connectclusters.ts

Global Arguments

ArgumentTypeDescription
capacityConfig?objectA capacity configuration of a Kafka cluster.
config?recordOptional. Reserved for future use. This field is meant for worker config overrides, but is unsupported for now.
gcpConfig?objectConfiguration properties for a Kafka Connect cluster deployed to Google Cloud Platform.
kafkaCluster?stringRequired. Immutable. The name of the Kafka cluster this Kafka Connect cluster is attached to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}
labels?recordOptional. Labels as key value pairs.
name?stringIdentifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id}
connectClusterId?stringRequired. The ID to use for the Connect cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-cluster-id`.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a connectClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a connectClusters
ArgumentTypeDescription
identifierstringThe name of the connectClusters
updateUpdate connectClusters attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the connectClusters
ArgumentTypeDescription
identifierstringThe name of the connectClusters
syncSync connectClusters state from GCP

Resources

state(infinite)— An Apache Kafka Connect cluster deployed in a location.
@swamp/gcp/managedkafka/connectclusters-connectorsv2026.04.23.1connectclusters_connectors.ts

Global Arguments

ArgumentTypeDescription
configs?recordOptional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
name?stringIdentifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
taskRestartPolicy?objectTask Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimum_backoff of 60 seconds, and a maximum_backoff of 12 hours. You can disable the policy by setting the task_retry_disabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen whe
connectorId?stringRequired. The ID to use for the connector, which will become the final component of the connector's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-connector-id`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a connectors
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a connectors
ArgumentTypeDescription
identifierstringThe name of the connectors
updateUpdate connectors attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the connectors
ArgumentTypeDescription
identifierstringThe name of the connectors
syncSync connectors state from GCP
pausepause
restartrestart
resumeresume
stopstop

Resources

state(infinite)— A Kafka Connect connector in a given ConnectCluster.
@swamp/gcp/managedkafka/locationsv2026.04.23.1locations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/managedkafka/schemaregistriesv2026.04.23.1schemaregistries.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
schemaRegistry?objectSchemaRegistry is a schema registry instance.
schemaRegistryId?stringRequired. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a schemaRegistries
getGet a schemaRegistries
ArgumentTypeDescription
identifierstringThe name of the schemaRegistries
deleteDelete the schemaRegistries
ArgumentTypeDescription
identifierstringThe name of the schemaRegistries
syncSync schemaRegistries state from GCP

Resources

state(infinite)— SchemaRegistry is a schema registry instance.
@swamp/gcp/managedkafka/schemaregistries-configv2026.04.23.1schemaregistries_config.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
compatibility?enumRequired. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
normalize?booleanOptional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
getGet a config
ArgumentTypeDescription
identifierstringThe name of the config
updateUpdate config attributes
deleteDelete the config
ArgumentTypeDescription
identifierstringThe name of the config
syncSync config state from GCP

Resources

state(infinite)— SchemaConfig represents configuration for a schema registry or a specific sub...
@swamp/gcp/managedkafka/schemaregistries-contextsv2026.04.23.1schemaregistries_contexts.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a contexts
ArgumentTypeDescription
identifierstringThe name of the contexts
syncSync contexts state from GCP

Resources

state(infinite)— Context represents an independent schema grouping in a schema registry instance.
@swamp/gcp/managedkafka/schemaregistries-contexts-configv2026.04.23.1schemaregistries_contexts_config.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
compatibility?enumRequired. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
normalize?booleanOptional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
getGet a config
ArgumentTypeDescription
identifierstringThe name of the config
updateUpdate config attributes
deleteDelete the config
ArgumentTypeDescription
identifierstringThe name of the config
syncSync config state from GCP

Resources

state(infinite)— SchemaConfig represents configuration for a schema registry or a specific sub...
@swamp/gcp/managedkafka/schemaregistries-contexts-modev2026.04.23.1schemaregistries_contexts_mode.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
mode?enumRequired. The mode type.
getGet a mode
ArgumentTypeDescription
identifierstringThe name of the mode
updateUpdate mode attributes
deleteDelete the mode
ArgumentTypeDescription
identifierstringThe name of the mode
syncSync mode state from GCP

Resources

state(infinite)— SchemaMode represents the mode of a schema registry or a specific subject. Fo...
@swamp/gcp/managedkafka/schemaregistries-contexts-schemasv2026.04.23.1schemaregistries_contexts_schemas.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
syncSync schemas state from GCP
get_schemaget schema

Resources

state(infinite)— Schema for a Kafka message.
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-subjectsv2026.04.23.1schemaregistries_contexts_schemas_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
syncSync subjects state from GCP

Resources

state(infinite)— List subjects which reference a particular schema id. The response will be an...
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-typesv2026.04.23.1schemaregistries_contexts_schemas_types.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a types
ArgumentTypeDescription
identifierstringThe name of the types
syncSync types state from GCP

Resources

state(infinite)— List the supported schema types. The response will be an array of schema types.
@swamp/gcp/managedkafka/schemaregistries-contexts-schemas-versionsv2026.04.23.1schemaregistries_contexts_schemas_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a versions
ArgumentTypeDescription
identifierstringThe name of the versions
syncSync versions state from GCP

Resources

state(infinite)— List the schema versions for the given schema id. The response will be an arr...
@swamp/gcp/managedkafka/schemaregistries-contexts-subjectsv2026.04.23.1schemaregistries_contexts_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
deleteDelete the subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
syncSync subjects state from GCP
lookup_versionlookup version
ArgumentTypeDescription
deleted?any
normalize?any
references?any
schema?any
schemaType?any

Resources

state(infinite)— List subjects in the schema registry. The response will be an array of subjec...
@swamp/gcp/managedkafka/schemaregistries-contexts-subjects-versionsv2026.04.23.1schemaregistries_contexts_subjects_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
id?numberOptional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
normalize?booleanOptional. If true, the schema will be normalized before being stored. The default is false.
references?arrayOptional. The schema references used by the schema.
schema?stringRequired. The schema payload
schemaType?enumOptional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
version?numberOptional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a versions
getGet a versions
ArgumentTypeDescription
identifierstringThe name of the versions
deleteDelete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
syncSync versions state from GCP
get_schemaget schema

Resources

state(infinite)— Version of a schema.
@swamp/gcp/managedkafka/schemaregistries-contexts-subjects-versions-referencedbyv2026.04.23.1schemaregistries_contexts_subjects_versions_referencedby.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a referencedby
ArgumentTypeDescription
identifierstringThe name of the referencedby
syncSync referencedby state from GCP

Resources

state(infinite)— Get a list of IDs of schemas that reference the schema with the given subject...
@swamp/gcp/managedkafka/schemaregistries-modev2026.04.23.1schemaregistries_mode.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
mode?enumRequired. The mode type.
getGet a mode
ArgumentTypeDescription
identifierstringThe name of the mode
updateUpdate mode attributes
deleteDelete the mode
ArgumentTypeDescription
identifierstringThe name of the mode
syncSync mode state from GCP

Resources

state(infinite)— SchemaMode represents the mode of a schema registry or a specific subject. Fo...
@swamp/gcp/managedkafka/schemaregistries-schemasv2026.04.23.1schemaregistries_schemas.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a schemas
ArgumentTypeDescription
identifierstringThe name of the schemas
syncSync schemas state from GCP
get_schemaget schema

Resources

state(infinite)— Schema for a Kafka message.
@swamp/gcp/managedkafka/schemaregistries-schemas-subjectsv2026.04.23.1schemaregistries_schemas_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
syncSync subjects state from GCP

Resources

state(infinite)— List subjects which reference a particular schema id. The response will be an...
@swamp/gcp/managedkafka/schemaregistries-schemas-typesv2026.04.23.1schemaregistries_schemas_types.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a types
ArgumentTypeDescription
identifierstringThe name of the types
syncSync types state from GCP

Resources

state(infinite)— List the supported schema types. The response will be an array of schema types.
@swamp/gcp/managedkafka/schemaregistries-schemas-versionsv2026.04.23.1schemaregistries_schemas_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a versions
ArgumentTypeDescription
identifierstringThe name of the versions
syncSync versions state from GCP

Resources

state(infinite)— List the schema versions for the given schema id. The response will be an arr...
@swamp/gcp/managedkafka/schemaregistries-subjectsv2026.04.23.1schemaregistries_subjects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
deleteDelete the subjects
ArgumentTypeDescription
identifierstringThe name of the subjects
syncSync subjects state from GCP
lookup_versionlookup version
ArgumentTypeDescription
deleted?any
normalize?any
references?any
schema?any
schemaType?any

Resources

state(infinite)— List subjects in the schema registry. The response will be an array of subjec...
@swamp/gcp/managedkafka/schemaregistries-subjects-versionsv2026.04.23.1schemaregistries_subjects_versions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
id?numberOptional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
normalize?booleanOptional. If true, the schema will be normalized before being stored. The default is false.
references?arrayOptional. The schema references used by the schema.
schema?stringRequired. The schema payload
schemaType?enumOptional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
version?numberOptional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a versions
getGet a versions
ArgumentTypeDescription
identifierstringThe name of the versions
deleteDelete the versions
ArgumentTypeDescription
identifierstringThe name of the versions
syncSync versions state from GCP
get_schemaget schema

Resources

state(infinite)— Version of a schema.
@swamp/gcp/managedkafka/schemaregistries-subjects-versions-referencedbyv2026.04.23.1schemaregistries_subjects_versions_referencedby.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a referencedby
ArgumentTypeDescription
identifierstringThe name of the referencedby
syncSync referencedby state from GCP

Resources

state(infinite)— Get a list of IDs of schemas that reference the schema with the given subject...