- NAME
-
- gcloud backup-dr backup-plan-associations create - create a new backup plan association
- SYNOPSIS
-
-
gcloud backup-dr backup-plan-associations create(BACKUP_PLAN_ASSOCIATION:--location=LOCATION--workload-project=WORKLOAD_PROJECT)--backup-plan=BACKUP_PLAN--resource=RESOURCE--resource-type=RESOURCE_TYPE[--async] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Create a new backup plan association in the project. It can only be created in locations where Backup and DR is available.
- EXAMPLES
- To create a new backup plan association
sample-bpain projectsample-projectand locationus-central1for resourcesample-resource-uriwith backup plansample-backup-plan, run:gcloud backup-dr backup-plan-associations create sample-bpa --project = sample-project --location = us-central1 --backup-plan = sample-backup-plan --resource = sample-resource-uri - POSITIONAL ARGUMENTS
-
- Backup Plan Association resource - Name of the backup plan association to be
created. Once the backup plan association is created, this name can't be
changed. The name must be unique for a project and location. To create backup
plan associations in a project that's different from the backup plan, use the
--workload-project flag. The arguments in this group can be used to specify the
attributes of this resource.
This must be specified.
-
BACKUP_PLAN_ASSOCIATION - ID of the Backup Plan Association or fully qualified identifier for the Backup
Plan Association.
To set the
nameattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- provide the argument
-
--location=LOCATION - The location of the Backup Plan Association.
To set the
locationattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line with a fully specified name; - provide the argument
--locationon the command line.
- provide the argument
-
--workload-project=WORKLOAD_PROJECT - Cloud project id for the Backup Plan Association.
To set the
workload-projectattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line with a fully specified name; - provide the argument
--workload-projecton the command line; - provide the argument
--projecton the command line; - set the property
core/project.
- provide the argument
-
- Backup Plan Association resource - Name of the backup plan association to be
created. Once the backup plan association is created, this name can't be
changed. The name must be unique for a project and location. To create backup
plan associations in a project that's different from the backup plan, use the
--workload-project flag. The arguments in this group can be used to specify the
attributes of this resource.
- REQUIRED FLAGS
-
- Backup Plan resource - The backup plan to be applied to the resource. E.g.,
projects/sample-project/locations/us-central1/backupPlans/sample-backup-plan
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
--backup-planon the command line with a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
To set the
locationattribute:- provide the argument
--backup-planon the command line with a fully specified name; - provide the argument
--locationon the command line.
This must be specified.
-
--backup-plan=BACKUP_PLAN - ID of the Backup Plan or fully qualified identifier for the Backup Plan.
To set the
nameattribute:- provide the argument
--backup-planon the command line.
- provide the argument
- provide the argument
-
--resource=RESOURCE - The resource to which the backup plan is to be applied. E.g., projects/sample-project/zones/us-central1-a/instances/sample-instance
-
--resource-type=RESOURCE_TYPE - Type of resource to which the backup plan should be applied.
For example:
-
compute.<UNIVERSE_DOMAIN>/Instancefor Compute Engine instances. -
file.<UNIVERSE_DOMAIN>/Instancefor Filestore instances.
-
- Backup Plan resource - The backup plan to be applied to the resource. E.g.,
projects/sample-project/locations/us-central1/backupPlans/sample-backup-plan
This represents a Cloud resource. (NOTE) Some attributes are not given arguments
in this group but can be set in other ways.
- OPTIONAL FLAGS
-
-
--async - Return immediately, without waiting for the operation in progress to complete.
The default is
True. Enabled by default, use--no-asyncto disable.
-
- 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. - BRIEF
- Creates a new backup plan association
- NOTES
- These variants are also available:
gcloud alpha backup-dr backup-plan-associations creategcloud beta backup-dr backup-plan-associations create
gcloud backup-dr backup-plan-associations create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

