gcloud alpha bigtable instances add-iam-policy-binding Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha bigtable instances add-iam-policy-binding - add an IAM policy binding to a Cloud Bigtable instance
- SYNOPSIS
gcloud alpha bigtable instances add-iam-policy-binding
INSTANCE
--member
=PRINCIPAL
--role
=ROLE
[--condition
=[KEY
=VALUE
,…] |--condition-from-file
=PATH_TO_FILE
][GCLOUD_WIDE_FLAG …
]
- DESCRIPTION
(ALPHA)
Add an IAM policy binding to a Cloud Bigtable instance. Onebinding consists of a member, a role, and an optional condition.- EXAMPLES
- To add an IAM policy binding for the role of
roles/editor
for theusertest-user@gmail.com
with instancemy-instance
,run:gcloudalphabigtableinstancesadd-iam-policy-bindingmy-instance--member=`user:test-user@gmail.com`--role=`roles/editor`
To add an IAM policy binding which expires at the end of the year 2018 for therole of
roles/bigtable.admin
and the usertest-user@gmail.com
with instancemy-instance
, run:gcloudalphabigtableinstancesadd-iam-policy-bindingmy-instance--member=`user:test-user@gmail.com`--role=`roles/bigtable.admin`--condition=`expression=request.time <timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018,description=Expiresatmidnighton2018-12-31`
Seehttps://cloud.google.com/iam/docs/managing-policiesfor details of policy role and member types.
- POSITIONAL ARGUMENTS
- Instance resource - The Cloud Bigtable instance to which to add the IAM policybinding. This represents a Cloud resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
project
attribute:- provide the argument
instance
on the command line with a fullyspecified name; - provide the argument
--project
on the command line; - set the property
core/project
.
This must be specified.
INSTANCE
- ID of the instance or fully qualified identifier for the instance.
To set the
instance
attribute:- provide the argument
instance
on the command line.
- provide the argument
- provide the argument
- Instance resource - The Cloud Bigtable instance to which to add the IAM policybinding. This represents a Cloud resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- REQUIRED FLAGS
--member
=PRINCIPAL
- The principal to add the binding for. Should be of the form
user|group|serviceAccount:email
ordomain: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
,--role
cannot 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
--condition
flag, 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 help
for details. - API REFERENCE
- This command uses the
bigtableadmin/v2
API. The full documentationfor this API can be found at:https://cloud.google.com/bigtable/ - 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:
gcloudbigtableinstancesadd-iam-policy-binding
gcloudbetabigtableinstancesadd-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-07-15 UTC.