Google Cloud Native v0.28.0, Feb 2 23

google-native.bigtableadmin/v2.Backup

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. Auto-naming is currently not supported for this resource.

Create Backup Resource

new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           backup_id: Optional[str] = None,
           cluster_id: Optional[str] = None,
           expire_time: Optional[str] = None,
           instance_id: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = None,
           source_table: Optional[str] = None)
@overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)

public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)

public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

type: google-native:bigtableadmin/v2:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Backup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Backup resource accepts the following input properties:

BackupId string: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
ClusterId string
ExpireTime string: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
InstanceId string
SourceTable string: 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}.
Name string: 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}.
Project string

BackupId string: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
ClusterId string
ExpireTime string: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
InstanceId string
SourceTable string: 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}.
Name string: 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}.
Project string

backupId String: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
clusterId String
expireTime String: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
instanceId String
sourceTable String: 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}.
name String: 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}.
project String

backupId string: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
clusterId string
expireTime string: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
instanceId string
sourceTable string: 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}.
name string: 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}.
project string

backup_id str: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
cluster_id str
expire_time str: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
instance_id str
source_table str: 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}.
name str: 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}.
project str

backupId String: Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
clusterId String
expireTime String: The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30 days from the time the request is received. Once the expire_time has passed, Cloud Bigtable will delete the backup and free the resources used by the backup.
instanceId String
sourceTable String: 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}.
name String: 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}.
project String

Outputs

All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

EncryptionInfo Pulumi.GoogleNative.BigtableAdmin.V2.Outputs.EncryptionInfoResponse: The encryption information for the backup.
EndTime string: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Id string: The provider-assigned unique ID for this managed resource.
SizeBytes string: Size of the backup in bytes.
SourceBackup string: 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//backups/.
StartTime string: 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 string: The current state of the backup.

EncryptionInfo EncryptionInfoResponse: The encryption information for the backup.
EndTime string: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
Id string: The provider-assigned unique ID for this managed resource.
SizeBytes string: Size of the backup in bytes.
SourceBackup string: 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//backups/.
StartTime string: 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 string: The current state of the backup.

encryptionInfo EncryptionInfoResponse: The encryption information for the backup.
endTime String: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
id String: The provider-assigned unique ID for this managed resource.
sizeBytes String: Size of the backup in bytes.
sourceBackup String: 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//backups/.
startTime String: 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 String: The current state of the backup.

encryptionInfo EncryptionInfoResponse: The encryption information for the backup.
endTime string: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
id string: The provider-assigned unique ID for this managed resource.
sizeBytes string: Size of the backup in bytes.
sourceBackup string: 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//backups/.
startTime string: 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 string: The current state of the backup.

encryption_info EncryptionInfoResponse: The encryption information for the backup.
end_time str: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
id str: The provider-assigned unique ID for this managed resource.
size_bytes str: Size of the backup in bytes.
source_backup str: 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//backups/.
start_time str: 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 str: The current state of the backup.

encryptionInfo Property Map: The encryption information for the backup.
endTime String: end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
id String: The provider-assigned unique ID for this managed resource.
sizeBytes String: Size of the backup in bytes.
sourceBackup String: 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//backups/.
startTime String: 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 String: The current state of the backup.

Supporting Types

EncryptionInfoResponse

EncryptionStatus Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.StatusResponse: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
EncryptionType string: The type of encryption used to protect this resource.
KmsKeyVersion string: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

EncryptionStatus StatusResponse: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
EncryptionType string: The type of encryption used to protect this resource.
KmsKeyVersion string: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

encryptionStatus StatusResponse: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
encryptionType String: The type of encryption used to protect this resource.
kmsKeyVersion String: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

encryptionStatus StatusResponse: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
encryptionType string: The type of encryption used to protect this resource.
kmsKeyVersion string: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

encryption_status StatusResponse: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
encryption_type str: The type of encryption used to protect this resource.
kms_key_version str: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

encryptionStatus Property Map: The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.
encryptionType String: The type of encryption used to protect this resource.
kmsKeyVersion String: The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: 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.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: 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.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: 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.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: 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.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: 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.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: 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.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0