gcloud-help/gcloud/spanner/backup-schedules/add-iam-policy-binding

NAME
    gcloud spanner backup-schedules add-iam-policy-binding - add IAM policy
        binding to a Cloud Spanner backup schedule

SYNOPSIS
    gcloud spanner backup-schedules add-iam-policy-binding
        (BACKUP_SCHEDULE : --database=DATABASE --instance=INSTANCE)
        --member=PRINCIPAL --role=ROLE
        [--condition=[KEY=VALUE,...] | --condition-from-file=PATH_TO_FILE]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    Add an IAM policy binding to a Cloud Spanner backup schedule. One binding
    consists of a member, a role, and an optional condition.

EXAMPLES
    To add an IAM policy binding for the role of 'roles/editor' for the user
    'test-user@gmail.com', run:

        $ gcloud spanner backup-schedules add-iam-policy-binding \
            backup-schedule-id --instance=instance-id \
            --database=database-id --member='user:test-user@gmail.com' \
            --role='roles/editor'

    To add an IAM policy binding which expires at the end of the year 2025 for
    the role of 'roles/editor' and the user 'test-user@gmail.com', run:

        $ gcloud spanner backup-schedules add-iam-policy-binding \
            backup-schedule-id --instance=instance-id \
            --database=database-id --member='user:test-user@gmail.com' \
            --role='roles/editor' \
            --condition='expression=request.time <
         timestamp("2026-01-01T00:00:00Z"),title=expires_end_of_2025,descrip\
        tion=Expires at midnight on 2025-12-31'

    See https://cloud.google.com/iam/docs/managing-policies for details of
    policy role and member types.

POSITIONAL ARGUMENTS
     BackupSchedule resource - The Cloud Spanner backup schedule to which to
     add the IAM policy binding. The arguments 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 in other ways.

     To set the project attribute:
      ◆ provide the argument backup_schedule on the command line with a fully
        specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

       BACKUP_SCHEDULE
          ID of the backupSchedule or fully qualified identifier for the
          backupSchedule.

          To set the backup_schedule attribute:
          ▸ provide the argument backup_schedule on the command line.

          This positional argument must be specified if any of the other
          arguments in this group are specified.

       --database=DATABASE
          The name of the Cloud Spanner database.

          To set the database attribute:
          ▸ provide the argument backup_schedule on the command line with a
            fully specified name;
          ▸ provide the argument --database on the command line.

       --instance=INSTANCE
          The name of the Cloud Spanner instance.

          To set the instance attribute:
          ▸ provide the argument backup_schedule on the command line with a
            fully specified name;
          ▸ provide the argument --instance on the command line;
          ▸ set the property spanner/instance.

REQUIRED FLAGS
     --member=PRINCIPAL
        The principal to add the binding for. Should be of the form
        user|group|serviceAccount:email or domain:domain.

        Examples: user:test-user@gmail.com, group:admins@example.com,
        serviceAccount:test123@example.domain.com, or
        domain:example.domain.com.

        Some resources also accept the following special values:
        ◆ allUsers - Special identifier that represents anyone who is on the
          internet, with or without a Google account.
        ◆ allAuthenticatedUsers - Special identifier that represents anyone
          who 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 a predefined role, such as roles/logging.viewer, or the role ID
        for a custom role, such as
        organizations/{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
          explicitly specified as None (--condition=None), a binding without a
          condition is added. When the condition is specified and is not None,
          --role cannot be a basic role. Basic roles are roles/editor,
          roles/owner, and roles/viewer. For more on conditions, refer to the
          conditions overview guide:
          https://cloud.google.com/iam/docs/conditions-overview

          When using the --condition flag, include the following key-value
          pairs:

           expression
              (Required) Condition expression that evaluates to True or False.
              This uses a subset of Common Expression Language syntax.

              If the condition expression includes a comma, use a different
              delimiter to separate the key-value pairs. Specify the delimiter
              before listing the key-value pairs. For example, to specify a
              colon (:) as the delimiter, do the following:
              --condition=^:^title=TITLE:expression=EXPRESSION. For more
              information, see
              https://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
          available fields, see the help for --condition. Use a full or
          relative path to a local file containing the value of condition.

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 spanner/v1 API. The full documentation for this API
    can be found at: https://cloud.google.com/spanner/

NOTES
    These variants are also available:

        $ gcloud alpha spanner backup-schedules add-iam-policy-binding

        $ gcloud beta spanner backup-schedules add-iam-policy-binding