gcloud alpha pubsub topics set-iam-policy Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha pubsub topics set-iam-policy - set the IAM policy for a Cloud Pub/Sub Topic
- SYNOPSIS
gcloud alpha pubsub topics set-iam-policyTOPICPOLICY_FILE[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)This command replaces the existing IAM policy for a topic,given a topic and a file encoded in JSON or YAML that contains the IAM policy.If the given policy file specifies an "etag" value, then the replacement willsucceed only if the policy already in place matches that etag. (An etag obtainedviaget-iam-policywill prevent the replacement if the policy forthe topic has been subsequently updated.) A policy file that does not contain anetag value will replace any existing policy for the topic.- EXAMPLES
- The following command will read an IAM policy defined in a JSON file'policy.json' and set it for a topic with identifier 'my-topic'
gcloudalphapubsubtopicsset-iam-policymy-topicpolicy.jsonSeehttps://cloud.google.com/iam/docs/managing-policiesfordetailsofthepolicyfileformatandcontents.
- POSITIONAL ARGUMENTS
- Topic resource - The topic for which to set the IAM policy. This represents aCloud resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
To set the
projectattribute:- provide the argument
topicon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
TOPIC- ID of the topic or fully qualified identifier for the topic.
To set the
topicattribute:- provide the argument
topicon the command line.
- provide the argument
- provide the argument
POLICY_FILE- Path to a local JSON or YAML formatted file containing a valid policy.
The output of the
get-iam-policycommand is a valid file, as is anyJSON or YAML file conforming to the structure of aPolicy.
- Topic resource - The topic for which to set the IAM policy. This represents aCloud resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
- 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
pubsub/v1API. The full documentation forthis API can be found at:https://cloud.google.com/pubsub/docs - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudpubsubtopicsset-iam-policygcloudbetapubsubtopicsset-iam-policy
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-07-22 UTC.