gcp_bigtableadmin_backup

ancestors

Type: UNORDERED_LIST_STRING

backup_type

Type: STRING
Provider name: backupType
Description: Indicates the backup type of the backup.
Possible values:

  • BACKUP_TYPE_UNSPECIFIED - Not specified.
  • STANDARD - The default type for Cloud Bigtable managed backups. Supported for backups created in both HDD and SSD instances. Requires optimization when restored to a table in an SSD instance.
  • HOT - A backup type with faster restore to SSD performance. Only supported for backups created in SSD instances. A new SSD table restored from a hot backup reaches production performance more quickly than a standard backup.

encryption_info

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

  • encryption_status
    Type: STRUCT
    Provider name: encryptionStatus
    Description: Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
    • code
      Type: INT32
      Provider name: code
      Description: The status code, which should be an enum value of google.rpc.Code.
    • message
      Type: STRING
      Provider name: message
      Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • encryption_type
    Type: STRING
    Provider name: encryptionType
    Description: Output only. The type of encryption used to protect this resource.
    Possible values:
    • ENCRYPTION_TYPE_UNSPECIFIED - Encryption type was not specified, though data at rest remains encrypted.
    • GOOGLE_DEFAULT_ENCRYPTION - The data backing this resource is encrypted at rest with a key that is fully managed by Google. No key version or status will be populated. This is the default state.
    • CUSTOMER_MANAGED_ENCRYPTION - The data backing this resource is encrypted at rest with a key that is managed by the customer. The in-use version of the key and its status are populated for CMEK-protected tables. CMEK-protected backups are pinned to the key version that was in use at the time the backup was taken. This key version is populated but its status is not tracked and is reported as UNKNOWN.
  • kms_key_version
    Type: STRING
    Provider name: kmsKeyVersion
    Description: Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

end_time

Type: TIMESTAMP
Provider name: endTime
Description: Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

expire_time

Type: TIMESTAMP
Provider name: expireTime
Description: Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the expire_time has passed, Cloud Bigtable will delete the backup.

hot_to_standard_time

Type: TIMESTAMP
Provider name: hotToStandardTime
Description: The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

size_bytes

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

source_backup

Type: STRING
Provider name: sourceBackup
Description: Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/

source_table

Type: STRING
Provider name: sourceTable
Description: Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.

start_time

Type: TIMESTAMP
Provider name: startTime
Description: Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

state

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

  • STATE_UNSPECIFIED - Not specified.
  • CREATING - The pending backup is still being created. Operations on the backup may fail with FAILED_PRECONDITION in this state.
  • READY - The backup is complete and ready for use.

tags

Type: UNORDERED_LIST_STRING

PREVIEWING: teddy.gesbert/doc-dora