gcloud beta spanner backups add-iam-policy-binding Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta spanner backups add-iam-policy-binding - add IAM policy binding to a Cloud Spanner backup
- SYNOPSIS
gcloud beta spanner backups add-iam-policy-binding(BACKUP:--instance=INSTANCE)--member=PRINCIPAL--role=ROLE[--condition=[KEY=VALUE,…] |--condition-from-file=PATH_TO_FILE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Add an IAM policy binding to a Cloud Spanner backup. Onebinding consists of a member, a role, and an optional condition.- EXAMPLES
- To add an IAM policy binding for the role of 'roles/spanner.backupAdmin' for theuser 'test-user@gmail.com' with backup 'example-backup' and instance'example-instance', run:
gcloudbetaspannerbackupsadd-iam-policy-bindingexample-backup--instance='example-instance'--member='user:test-user@gmail.com'--role='roles/spanner.backupAdmin'To add an IAM policy binding which expires at the end of the year 2018 for therole of 'roles/spanner.backupAdmin' and the user 'test-user@gmail.com' withbackup 'example-backup' and instance 'example-instance', run:
gcloudbetaspannerbackupsadd-iam-policy-bindingexample-backup--instance='example-instance'--member='user:test-user@gmail.com'--role='roles/spanner.backupAdmin'--condition='expression=request.time<timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,descrip\tion=Expires at midnight on 2018-12-31'Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of policy role and member types.
- POSITIONAL ARGUMENTS
- Backup resource - The Cloud Spanner backup to which to add the IAM policybinding. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
To set the
projectattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
BACKUP- ID of the backup or fully qualified identifier for the backup.
To set the
backupattribute:- provide the argument
backupon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--instance=INSTANCE- The name of the Cloud Spanner instance.To set the
instanceattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--instanceon the command line; - set the property
spanner/instance.
- provide the argument
- provide the argument
- Backup resource - The Cloud Spanner backup to which to add the IAM policybinding. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
- REQUIRED FLAGS
--member=PRINCIPAL- The principal to add the binding for. Should be of the form
user|group|serviceAccount:emailordomain:domain.Examples:
user:test-user@gmail.com,group:admins@example.com,serviceAccount:test123@example.domain.com, ordomain:example.domain.com.Some resources also accept the following special values:
allUsers- Special identifier that represents anyone who is on theinternet, with or without a Google account.allAuthenticatedUsers- Special identifier that represents anyonewho is authenticated with a Google account or a service account.
--role=ROLE- Role name to assign to the principal. The role name is the complete path of apredefined role, such as
roles/logging.viewer, or the role ID for acustom role, such asorganizations/{ORGANIZATION_ID}/roles/logging.viewer.
- OPTIONAL FLAGS
- At most one of these can be specified:
--condition=[KEY=VALUE,…]- A condition to include in the binding. When the condition is explicitlyspecified as
None(--condition=None), a bindingwithout a condition is added. When the condition is specified and is notNone,--rolecannot be a basic role. Basic roles areroles/editor,roles/owner, androles/viewer. For more on conditions, refer to the conditionsoverview guide:https://cloud.google.com/iam/docs/conditions-overviewWhen using the
--conditionflag, include the following key-valuepairs:expression- (Required) Condition expression that evaluates to True or False. This uses asubset of Common Expression Language syntax.
If the condition expression includes a comma, use a different delimiter toseparate the key-value pairs. Specify the delimiter before listing the key-valuepairs. For example, to specify a colon (
:) as the delimiter, do thefollowing:--condition=^:^title=TITLE:expression=EXPRESSION. Formore information, seehttps://cloud.google.com/sdk/gcloud/reference/topic/escaping. title- (Required) A short string describing the purpose of the expression.
description- (Optional) Additional description for the expression.
--condition-from-file=PATH_TO_FILE- Path to a local JSON or YAML file that defines the condition. To see availablefields, see the help for
--condition. Use a full or relative pathto a local file containing the value of condition.
- At most one of these can be specified:
- 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
spanner/v1API. The full documentation forthis API can be found at:https://cloud.google.com/spanner/ - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudspannerbackupsadd-iam-policy-bindinggcloudalphaspannerbackupsadd-iam-policy-binding
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.