gcloud spanner instances set-iam-policy

NAME
gcloud spanner instances set-iam-policy - set the IAM policy for a Cloud Spanner instance
SYNOPSIS
gcloud spanner instances set-iam-policy[INSTANCE]POLICY_FILE[GCLOUD_WIDE_FLAG …]
DESCRIPTION
Set the IAM policy for a Cloud Spanner instance given a instance ID and a fileencoded in JSON or YAML that contains the IAM policy.
EXAMPLES
The following command reads an IAM policy defined in a JSON filepolicy.json and sets it for a spanner instance with the IDexample-instance:
gcloudspannerinstancesset-iam-policyexample-instancepolicy.json

Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of the policy file format and contents.

POSITIONAL ARGUMENTS
Instance resource - The Spanner instance to set the IAM policy for. Thisrepresents a Cloud resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.

To set theproject attribute:

  • provide the argumentinstance on the command line with a fullyspecified name;
  • set the propertyspanner/instance with a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.
[INSTANCE]
ID of the instance or fully qualified identifier for the instance.

To set theinstance attribute:

  • provide the argumentinstance on the command line;
  • set the propertyspanner/instance.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.

The output of theget-iam-policy command is a valid file, as is anyJSON or YAML file conforming to the structure of aPolicy.

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 help for details.

API REFERENCE
This command uses thespanner/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/spanner/
NOTES
These variants are also available:
gcloudalphaspannerinstancesset-iam-policy
gcloudbetaspannerinstancesset-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 2026-02-18 UTC.