gcloud managed-kafka acls update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud managed-kafka acls update - update a Managed Service for Apache Kafka acl
- SYNOPSIS
gcloud managed-kafka acls update(ACL:--cluster=CLUSTER--location=LOCATION)--etag=ETAG(--acl-entries-from-file=PATH_TO_FILE|--acl-entry=[host=HOST],[operation=OPERATION],[permission-type=PERMISSION-TYPE],[principal=PRINCIPAL])[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update a Managed Service for Apache Kafka acl.
NOTE: update performs a FULL REPLACEMENT of acl entries. For incrementalupdates, use add-acl-entry and remove-acl-entry commands.
- EXAMPLES
- To update an acl for the Kafka cluster resource pattern, with etag W/XYZ123returned from a previous create or describe command, in a cluster namedmycluster located in us-central1, run the following:
gcloudmanaged-kafkaaclsupdatecluster--cluster=mycluster--location=us-central1--acl-entry=principal='User:admin@project.iam.gserviceaccount.com',operation=ALL,permission-type=ALLOW,host='*'--etag=W/XYZ123 - POSITIONAL ARGUMENTS
- Acl resource - Identifies the name of the acl that this command updates. 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
aclon the command line with a fully specifiedname; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
ACL- ID of the acl or fully qualified identifier for the acl.
To set the
aclattribute:- provide the argument
aclon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--cluster=CLUSTER- The cluster name.To set the
clusterattribute:- provide the argument
aclon the command line with a fully specifiedname; - provide the argument
--clusteron the command line.
- 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
aclon the command line with a fully specifiedname; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Acl resource - Identifies the name of the acl that this command updates. 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
--etag=ETAG- etag returned in the response to a previous create or describe command. The etagis used for concurrency control, to ensure that the client and server agree onthe current set of acl entries in the Kafka cluster, before full replacement inthe update command.
- Exactly one of these must be specified:
--acl-entries-from-file=PATH_TO_FILE- Path to a JSON or YAML file containing the acl entries to use in the acl. Use afull or relative path to a local file containing the value of acl_entries.
--acl-entry=[host=HOST],[operation=OPERATION],[permission-type=PERMISSION-TYPE],[principal=PRINCIPAL]- An acl entry that configures access for a principal, for a specific operation onthe acl's resource pattern. This flag can be repeated.
is the principal. Specified asGoogle Cloud account, with the Kafka StandardAuthorizer prefix "User:". Forexample: "User:admin@project.iam.gserviceaccount.com". Can be the wildcard"User:PRINCIPAL*" to refer to all users.is the operation type. Allowedvalues are: ALL, READ, WRITE, CREATE, DELETE, ALTER, DESCRIBE, CLUSTER_ACTION,DESCRIBE_CONFIGS, ALTER_CONFIGS, IDEMPOTENT_WRITE.OPERATIONis the permission type.Allowed values are: ALLOW, DENY.PERMISSION-TYPEis the host. Must be set to"HOST*" for Managed Service for Apache Kafka.Example acl-entry:"principal=User:admin@project.iam.gserviceaccount.com,operation=ALL,permission-type=ALLOW,host=
*"
- 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-kafkaaclsupdategcloudbetamanaged-kafkaaclsupdate
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-05-07 UTC.