Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. alloydb
  5. alloydb/v1
  6. getBackup

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
pulumi/pulumi-google-native

google-native.alloydb/v1.getBackup

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
pulumi/pulumi-google-native

Gets details of a single Backup.

Using getBackup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOptions): Output<GetBackupResult>
Copy
def get_backup(backup_id: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBackupResult]
Copy
func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput
Copy

> Note: This function is named LookupBackup in the Go SDK.

public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:alloydb/v1:getBackup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupId This property is required. string
Location This property is required. string
Project string
BackupId This property is required. string
Location This property is required. string
Project string
backupId This property is required. String
location This property is required. String
project String
backupId This property is required. string
location This property is required. string
project string
backup_id This property is required. str
location This property is required. str
project str
backupId This property is required. String
location This property is required. String
project String

getBackup Result

The following output properties are available:

Annotations Dictionary<string, string>
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
ClusterName string
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
ClusterUid string
The system-generated UID of the cluster which was used to create this resource.
CreateTime string
Create time stamp
DatabaseVersion string
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.
DeleteTime string
Delete time stamp
Description string
User-provided description of the backup.
DisplayName string
User-settable and human-readable display name for the Backup.
EncryptionConfig Pulumi.GoogleNative.AlloyDB.V1.Outputs.EncryptionConfigResponse
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.
EncryptionInfo Pulumi.GoogleNative.AlloyDB.V1.Outputs.EncryptionInfoResponse
The encryption information for the backup.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
ExpiryQuantity Pulumi.GoogleNative.AlloyDB.V1.Outputs.QuantityBasedExpiryResponse
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.
ExpiryTime string
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.
Labels Dictionary<string, string>
Labels as key value pairs
Name string
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}
Reconciling bool
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.
SizeBytes string
The size of the backup in bytes.
State string
The current state of the backup.
Type string
The backup type, which suggests the trigger for the backup.
Uid string
The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string
Update time stamp
Annotations map[string]string
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
ClusterName string
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
ClusterUid string
The system-generated UID of the cluster which was used to create this resource.
CreateTime string
Create time stamp
DatabaseVersion string
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.
DeleteTime string
Delete time stamp
Description string
User-provided description of the backup.
DisplayName string
User-settable and human-readable display name for the Backup.
EncryptionConfig EncryptionConfigResponse
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.
EncryptionInfo EncryptionInfoResponse
The encryption information for the backup.
Etag string
For Resource freshness validation (https://google.aip.dev/154)
ExpiryQuantity QuantityBasedExpiryResponse
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.
ExpiryTime string
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.
Labels map[string]string
Labels as key value pairs
Name string
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}
Reconciling bool
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.
SizeBytes string
The size of the backup in bytes.
State string
The current state of the backup.
Type string
The backup type, which suggests the trigger for the backup.
Uid string
The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string
Update time stamp
annotations Map<String,String>
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
clusterName String
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
clusterUid String
The system-generated UID of the cluster which was used to create this resource.
createTime String
Create time stamp
databaseVersion String
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.
deleteTime String
Delete time stamp
description String
User-provided description of the backup.
displayName String
User-settable and human-readable display name for the Backup.
encryptionConfig EncryptionConfigResponse
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.
encryptionInfo EncryptionInfoResponse
The encryption information for the backup.
etag String
For Resource freshness validation (https://google.aip.dev/154)
expiryQuantity QuantityBasedExpiryResponse
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.
expiryTime String
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.
labels Map<String,String>
Labels as key value pairs
name String
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}
reconciling Boolean
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.
sizeBytes String
The size of the backup in bytes.
state String
The current state of the backup.
type String
The backup type, which suggests the trigger for the backup.
uid String
The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String
Update time stamp
annotations {[key: string]: string}
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
clusterName string
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
clusterUid string
The system-generated UID of the cluster which was used to create this resource.
createTime string
Create time stamp
databaseVersion string
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.
deleteTime string
Delete time stamp
description string
User-provided description of the backup.
displayName string
User-settable and human-readable display name for the Backup.
encryptionConfig EncryptionConfigResponse
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.
encryptionInfo EncryptionInfoResponse
The encryption information for the backup.
etag string
For Resource freshness validation (https://google.aip.dev/154)
expiryQuantity QuantityBasedExpiryResponse
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.
expiryTime string
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.
labels {[key: string]: string}
Labels as key value pairs
name string
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}
reconciling boolean
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.
sizeBytes string
The size of the backup in bytes.
state string
The current state of the backup.
type string
The backup type, which suggests the trigger for the backup.
uid string
The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime string
Update time stamp
annotations Mapping[str, str]
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
cluster_name str
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
cluster_uid str
The system-generated UID of the cluster which was used to create this resource.
create_time str
Create time stamp
database_version str
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.
delete_time str
Delete time stamp
description str
User-provided description of the backup.
display_name str
User-settable and human-readable display name for the Backup.
encryption_config EncryptionConfigResponse
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.
encryption_info EncryptionInfoResponse
The encryption information for the backup.
etag str
For Resource freshness validation (https://google.aip.dev/154)
expiry_quantity QuantityBasedExpiryResponse
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.
expiry_time str
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.
labels Mapping[str, str]
Labels as key value pairs
name str
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}
reconciling bool
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.
size_bytes str
The size of the backup in bytes.
state str
The current state of the backup.
type str
The backup type, which suggests the trigger for the backup.
uid str
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 str
Update time stamp
annotations Map<String>
Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
clusterName String
The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
clusterUid String
The system-generated UID of the cluster which was used to create this resource.
createTime String
Create time stamp
databaseVersion String
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.
deleteTime String
Delete time stamp
description String
User-provided description of the backup.
displayName String
User-settable and human-readable display name for the Backup.
encryptionConfig Property Map
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.
encryptionInfo Property Map
The encryption information for the backup.
etag String
For Resource freshness validation (https://google.aip.dev/154)
expiryQuantity Property Map
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.
expiryTime String
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.
labels Map<String>
Labels as key value pairs
name String
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}
reconciling Boolean
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.
sizeBytes String
The size of the backup in bytes.
state String
The current state of the backup.
type String
The backup type, which suggests the trigger for the backup.
uid String
The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String
Update time stamp

Supporting Types

EncryptionConfigResponse

KmsKeyName This property is required. string
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]
KmsKeyName This property is required. string
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]
kmsKeyName This property is required. String
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]
kmsKeyName This property is required. string
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]
kms_key_name This property is required. str
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]
kmsKeyName This property is required. String
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]

EncryptionInfoResponse

EncryptionType This property is required. string
Type of encryption.
KmsKeyVersions This property is required. List<string>
Cloud KMS key versions that are being used to protect the database or the backup.
EncryptionType This property is required. string
Type of encryption.
KmsKeyVersions This property is required. []string
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. String
Type of encryption.
kmsKeyVersions This property is required. List<String>
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. string
Type of encryption.
kmsKeyVersions This property is required. string[]
Cloud KMS key versions that are being used to protect the database or the backup.
encryption_type This property is required. str
Type of encryption.
kms_key_versions This property is required. Sequence[str]
Cloud KMS key versions that are being used to protect the database or the backup.
encryptionType This property is required. String
Type of encryption.
kmsKeyVersions This property is required. List<String>
Cloud KMS key versions that are being used to protect the database or the backup.

QuantityBasedExpiryResponse

RetentionCount This property is required. int
The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
TotalRetentionCount This property is required. int
The length of the quantity-based queue, specified by the backup's retention policy.
RetentionCount This property is required. int
The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
TotalRetentionCount This property is required. int
The length of the quantity-based queue, specified by the backup's retention policy.
retentionCount This property is required. Integer
The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
totalRetentionCount This property is required. Integer
The length of the quantity-based queue, specified by the backup's retention policy.
retentionCount This property is required. number
The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
totalRetentionCount This property is required. number
The length of the quantity-based queue, specified by the backup's retention policy.
retention_count This property is required. int
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 This property is required. int
The length of the quantity-based queue, specified by the backup's retention policy.
retentionCount This property is required. Number
The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
totalRetentionCount This property is required. Number
The length of the quantity-based queue, specified by the backup's retention policy.

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
pulumi/pulumi-google-native