gcp_alloydb_backup

ancestors

Type: UNORDERED_LIST_STRING

annotations

Type: MAP_STRING_STRING
Provider name: annotations
Description: Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

cluster_name

Type: STRING
Provider name: clusterName
Description: Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

cluster_uid

Type: STRING
Provider name: clusterUid
Description: Output only. The system-generated UID of the cluster which was used to create this resource.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Create time stamp

database_version

Type: STRING
Provider name: databaseVersion
Description: Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.
Possible values:

• DATABASE_VERSION_UNSPECIFIED - This is an unknown database version.
  
• POSTGRES_13 - DEPRECATED - The database version is Postgres 13.
  
• POSTGRES_14 - The database version is Postgres 14.
  
• POSTGRES_15 - The database version is Postgres 15.
  
• POSTGRES_16 - The database version is Postgres 16.
  

delete_time

Type: TIMESTAMP
Provider name: deleteTime
Description: Output only. Delete time stamp

description

Type: STRING
Provider name: description
Description: User-provided description of the backup.

encryption_config

Type: STRUCT
Provider name: encryptionConfig
Description: Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
  

encryption_info

Type: STRUCT
Provider name: encryptionInfo
Description: Output only. The encryption information for the backup.

• encryption_type
  Type: STRING
  Provider name: encryptionType
  Description: Output only. Type of encryption.
  Possible values:
  
  • TYPE_UNSPECIFIED - Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
    
  • GOOGLE_DEFAULT_ENCRYPTION - The data is encrypted at rest with a key that is fully managed by Google. No key version will be populated. This is the default state.
    
  • CUSTOMER_MANAGED_ENCRYPTION - The data is encrypted at rest with a key that is managed by the customer. KMS key versions will be populated.
    
• kms_key_versions
  Type: UNORDERED_LIST_STRING
  Provider name: kmsKeyVersions
  Description: Output only. Cloud KMS key versions that are being used to protect the database or the backup.
  

etag

Type: STRING
Provider name: etag
Description: For Resource freshness validation (https://google.aip.dev/154)

expiry_quantity

Type: STRUCT
Provider name: expiryQuantity
Description: Output only. The QuantityBasedExpiry of the backup, specified by the backup’s retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.

• retention_count
  Type: INT32
  Provider name: retentionCount
  Description: Output only. The backup’s position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
  
• total_retention_count
  Type: INT32
  Provider name: totalRetentionCount
  Description: Output only. The length of the quantity-based queue, specified by the backup’s retention policy.
  

expiry_time

Type: TIMESTAMP
Provider name: expiryTime
Description: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup’s retention policy, added to the backup’s create_time.

gcp_display_name

Type: STRING
Provider name: displayName
Description: User-settable and human-readable display name for the Backup.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

resource_name

Type: STRING

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

size_bytes

Type: INT64
Provider name: sizeBytes
Description: Output only. The size of the backup in bytes.

state

Type: STRING
Provider name: state
Description: Output only. The current state of the backup.
Possible values:

• STATE_UNSPECIFIED - The state of the backup is unknown.
  
• READY - The backup is ready.
  
• CREATING - The backup is creating.
  
• FAILED - The backup failed.
  
• DELETING - The backup is being deleted.
  

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: The backup type, which suggests the trigger for the backup.
Possible values:

• TYPE_UNSPECIFIED - Backup Type is unknown.
  
• ON_DEMAND - ON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
  
• AUTOMATED - AUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
  
• CONTINUOUS - CONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.
  

uid

Type: STRING
Provider name: uid
Description: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Update time stamp