# REST Resource: projects.locations.backupPlanAssociations

- [Resource: BackupPlanAssociation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#BackupPlanAssociation)
  - [JSON representation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#BackupPlanAssociation.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#State)
- [RuleConfigInfo](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#RuleConfigInfo)
  - [JSON representation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#RuleConfigInfo.SCHEMA_REPRESENTATION)
- [LastBackupState](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#LastBackupState)
- [CloudSqlInstanceBackupPlanAssociationProperties](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#CloudSqlInstanceBackupPlanAssociationProperties)
  - [JSON representation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#CloudSqlInstanceBackupPlanAssociationProperties.SCHEMA_REPRESENTATION)
- [FilestoreInstanceBackupPlanAssociationProperties](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#FilestoreInstanceBackupPlanAssociationProperties)
  - [JSON representation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#FilestoreInstanceBackupPlanAssociationProperties.SCHEMA_REPRESENTATION)
- [AlloyDBClusterBackupPlanAssociationProperties](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#AlloyDBClusterBackupPlanAssociationProperties)
  - [JSON representation](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#AlloyDBClusterBackupPlanAssociationProperties.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#METHODS_SUMMARY)

## Resource: BackupPlanAssociation

A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc

| JSON representation |
|---|
| ``` { "name": string, "resourceType": string, "resource": string, "backupPlan": string, "createTime": string, "updateTime": string, "state": enum (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#State`), "rulesConfigInfo": [ { object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#RuleConfigInfo`) } ], "dataSource": string, "backupPlanRevisionId": string, "backupPlanRevisionName": string, // Union field `resource_properties` can be only one of the following: "cloudSqlInstanceBackupPlanAssociationProperties": { object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#CloudSqlInstanceBackupPlanAssociationProperties`) }, "filestoreInstanceBackupPlanAssociationProperties": { object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#FilestoreInstanceBackupPlanAssociationProperties`) }, "alloydbClusterBackupPlanAssociationProperties": { object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#AlloyDBClusterBackupPlanAssociationProperties`) } // End of list of possible types for union field `resource_properties`. } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} |
| `resourceType` | `string` Required. Immutable. Resource type of workload on which backupplan is applied |
| `resource` | `string` Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance"). |
| `backupPlan` | `string` Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the instance was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the instance was updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `state` | ``enum (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#State`)`` Output only. The BackupPlanAssociation resource state. |
| `rulesConfigInfo[]` | ``object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#RuleConfigInfo`)`` Output only. The config info related to backup rules. |
| `dataSource` | `string` Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} |
| `backupPlanRevisionId` | `string` Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. |
| `backupPlanRevisionName` | `string` Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backupPlan}/revisions/{revisionId}` |
| Union field `resource_properties`. Properties of the protected Google Cloud resource. `resource_properties` can be only one of the following: ||
| `cloudSqlInstanceBackupPlanAssociationProperties` | ``object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#CloudSqlInstanceBackupPlanAssociationProperties`)`` Output only. Cloud SQL instance's backup plan association properties. |
| `filestoreInstanceBackupPlanAssociationProperties` | ``object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#FilestoreInstanceBackupPlanAssociationProperties`)`` Output only. Filestore instance's backup plan association properties. |
| `alloydbClusterBackupPlanAssociationProperties` | ``object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#AlloyDBClusterBackupPlanAssociationProperties`)`` Output only. AlloyDB cluster's backup plan association properties. |

## State

Enum for State of BackupPlan Association

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State not set. |
| `CREATING` | The resource is being created. |
| `ACTIVE` | The resource has been created and is fully usable. |
| `DELETING` | The resource is being deleted. |
| `INACTIVE` | The resource has been created but is not usable. |
| `UPDATING` | The resource is being updated. |

## RuleConfigInfo

Message for rules config info.

| JSON representation |
|---|
| ``` { "ruleId": string, "lastBackupState": enum (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#LastBackupState`), "lastBackupError": { object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/Status`) }, "lastSuccessfulBackupConsistencyTime": string } ``` |

| Fields ||
|---|---|
| `ruleId` | `string` Output only. Backup Rule id fetched from backup plan. |
| `lastBackupState` | ``enum (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations#LastBackupState`)`` Output only. The last backup state for rule. |
| `lastBackupError` | ``object (`https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/Status`)`` Output only. google.rpc.Status object to store the last backup error. |
| `lastSuccessfulBackupConsistencyTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The point in time when the last successful backup was captured from the source. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## LastBackupState

Enum for LastBackupState

| Enums ||
|---|---|
| `LAST_BACKUP_STATE_UNSPECIFIED` | State not set. |
| `FIRST_BACKUP_PENDING` | The first backup is pending. |
| `PERMISSION_DENIED` | The most recent backup could not be run/failed because of the lack of permissions. |
| `SUCCEEDED` | The last backup operation succeeded. |
| `FAILED` | The last backup operation failed. |

## CloudSqlInstanceBackupPlanAssociationProperties

Cloud SQL instance's BPA properties.

| JSON representation |
|---|
| ``` { "instanceCreateTime": string } ``` |

| Fields ||
|---|---|
| `instanceCreateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the instance was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## FilestoreInstanceBackupPlanAssociationProperties

Filestore instance's BPA properties.

| JSON representation |
|---|
| ``` { "instanceCreateTime": string } ``` |

| Fields ||
|---|---|
| `instanceCreateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the instance was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## AlloyDBClusterBackupPlanAssociationProperties

Properties for an AlloyDB cluster backup plan association.

| JSON representation |
|---|
| ``` { "clusterUid": string } ``` |

| Fields ||
|---|---|
| `clusterUid` | `string` Output only. The cluster UID of the AlloyDB cluster. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/create` | Create a BackupPlanAssociation |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/delete` | Deletes a single BackupPlanAssociation. |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/fetchForResourceType` | List BackupPlanAssociations for a given resource type. |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/get` | Gets details of a single BackupPlanAssociation. |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/list` | Lists BackupPlanAssociations in a given project and location. |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/patch` | Update a BackupPlanAssociation. |
| ### `https://docs.cloud.google.com/backup-disaster-recovery/docs/reference/rest/v1/projects.locations.backupPlanAssociations/triggerBackup` | Triggers a new Backup. |