1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigtableadmin
  5. bigtableadmin/v2
  6. Backup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.bigtableadmin/v2.Backup

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

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

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
@overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@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,
           source_table: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BackupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplebackupResourceResourceFromBigtableadminv2 = new GoogleNative.BigtableAdmin.V2.Backup("examplebackupResourceResourceFromBigtableadminv2", new()
{
    BackupId = "string",
    ClusterId = "string",
    ExpireTime = "string",
    InstanceId = "string",
    SourceTable = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := bigtableadmin.NewBackup(ctx, "examplebackupResourceResourceFromBigtableadminv2", &bigtableadmin.BackupArgs{
	BackupId:    pulumi.String("string"),
	ClusterId:   pulumi.String("string"),
	ExpireTime:  pulumi.String("string"),
	InstanceId:  pulumi.String("string"),
	SourceTable: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Project:     pulumi.String("string"),
})
Copy
var examplebackupResourceResourceFromBigtableadminv2 = new Backup("examplebackupResourceResourceFromBigtableadminv2", BackupArgs.builder()
    .backupId("string")
    .clusterId("string")
    .expireTime("string")
    .instanceId("string")
    .sourceTable("string")
    .name("string")
    .project("string")
    .build());
Copy
examplebackup_resource_resource_from_bigtableadminv2 = google_native.bigtableadmin.v2.Backup("examplebackupResourceResourceFromBigtableadminv2",
    backup_id="string",
    cluster_id="string",
    expire_time="string",
    instance_id="string",
    source_table="string",
    name="string",
    project="string")
Copy
const examplebackupResourceResourceFromBigtableadminv2 = new google_native.bigtableadmin.v2.Backup("examplebackupResourceResourceFromBigtableadminv2", {
    backupId: "string",
    clusterId: "string",
    expireTime: "string",
    instanceId: "string",
    sourceTable: "string",
    name: "string",
    project: "string",
});
Copy
type: google-native:bigtableadmin/v2:Backup
properties:
    backupId: string
    clusterId: string
    expireTime: string
    instanceId: string
    name: string
    project: string
    sourceTable: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Backup resource accepts the following input properties:

BackupId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
ExpireTime This property is required. string
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
string
SourceTable This property is required. 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 Changes to this property will trigger replacement. string
BackupId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
ExpireTime This property is required. string
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
string
SourceTable This property is required. 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 Changes to this property will trigger replacement. string
backupId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
expireTime This property is required. String
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
String
sourceTable This property is required. 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 Changes to this property will trigger replacement. String
backupId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
expireTime This property is required. string
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
string
sourceTable This property is required. 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 Changes to this property will trigger replacement. string
backup_id
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
expire_time This property is required. str
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
str
source_table This property is required. 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 Changes to this property will trigger replacement. str
backupId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
expireTime This property is required. String
The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 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
This property is required.
Changes to this property will trigger replacement.
String
sourceTable This property is required. 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 Changes to this property will trigger replacement. 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
, EncryptionInfoResponseArgs

EncryptionStatus This property is required. 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 This property is required. string
The type of encryption used to protect this resource.
KmsKeyVersion This property is required. string
The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
EncryptionStatus This property is required. 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 This property is required. string
The type of encryption used to protect this resource.
KmsKeyVersion This property is required. string
The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
encryptionStatus This property is required. 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 This property is required. String
The type of encryption used to protect this resource.
kmsKeyVersion This property is required. String
The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
encryptionStatus This property is required. 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 This property is required. string
The type of encryption used to protect this resource.
kmsKeyVersion This property is required. 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 This property is required. 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 This property is required. str
The type of encryption used to protect this resource.
kms_key_version This property is required. str
The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
encryptionStatus This property is required. 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 This property is required. String
The type of encryption used to protect this resource.
kmsKeyVersion This property is required. String
The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

StatusResponse
, StatusResponseArgs

Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. 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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []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 This property is required. 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 This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi