Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Google Native

v0.9.0 published on Wednesday, Nov 24, 2021 by Pulumi

BackupRun

Creates a new backup run on demand. Auto-naming is currently not supported for this resource.

Create a BackupRun Resource

new BackupRun(name: string, args: BackupRunArgs, opts?: CustomResourceOptions);
@overload
def BackupRun(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              backup_kind: Optional[BackupRunBackupKind] = None,
              description: Optional[str] = None,
              disk_encryption_configuration: Optional[DiskEncryptionConfigurationArgs] = None,
              disk_encryption_status: Optional[DiskEncryptionStatusArgs] = None,
              end_time: Optional[str] = None,
              enqueued_time: Optional[str] = None,
              error: Optional[OperationErrorArgs] = None,
              id: Optional[str] = None,
              instance: Optional[str] = None,
              kind: Optional[str] = None,
              location: Optional[str] = None,
              project: Optional[str] = None,
              self_link: Optional[str] = None,
              start_time: Optional[str] = None,
              status: Optional[BackupRunStatus] = None,
              type: Optional[BackupRunType] = None,
              window_start_time: Optional[str] = None)
@overload
def BackupRun(resource_name: str,
              args: BackupRunArgs,
              opts: Optional[ResourceOptions] = None)
func NewBackupRun(ctx *Context, name string, args BackupRunArgs, opts ...ResourceOption) (*BackupRun, error)
public BackupRun(string name, BackupRunArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BackupRunArgs
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 BackupRunArgs
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 BackupRunArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackupRunArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

BackupRun 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 BackupRun resource accepts the following input properties:

Instance string
Name of the database instance.
BackupKind Pulumi.GoogleNative.SQLAdmin.V1Beta4.BackupRunBackupKind
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Description string
The description of this run, only applicable to on-demand backups.
DiskEncryptionConfiguration Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.DiskEncryptionConfigurationArgs
Encryption configuration specific to a backup.
DiskEncryptionStatus Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.DiskEncryptionStatusArgs
Encryption status specific to a backup.
EndTime string
The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
EnqueuedTime string
The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Error Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.OperationErrorArgs
Information about why the backup operation failed. This is only present if the run has the FAILED status.
Id string
The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Kind string
This is always sql#backupRun.
Location string
Location of the backups.
Project string
SelfLink string
The URI of this resource.
StartTime string
The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Status Pulumi.GoogleNative.SQLAdmin.V1Beta4.BackupRunStatus
The status of this run.
Type Pulumi.GoogleNative.SQLAdmin.V1Beta4.BackupRunType
The type of this run; can be either “AUTOMATED” or “ON_DEMAND”. This field defaults to “ON_DEMAND” and is ignored, when specified for insert requests.
WindowStartTime string
The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Instance string
Name of the database instance.
BackupKind BackupRunBackupKind
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Description string
The description of this run, only applicable to on-demand backups.
DiskEncryptionConfiguration DiskEncryptionConfigurationArgs
Encryption configuration specific to a backup.
DiskEncryptionStatus DiskEncryptionStatusArgs
Encryption status specific to a backup.
EndTime string
The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
EnqueuedTime string
The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Error OperationErrorArgs
Information about why the backup operation failed. This is only present if the run has the FAILED status.
Id string
The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Kind string
This is always sql#backupRun.
Location string
Location of the backups.
Project string
SelfLink string
The URI of this resource.
StartTime string
The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
Status BackupRunStatus
The status of this run.
Type BackupRunType
The type of this run; can be either “AUTOMATED” or “ON_DEMAND”. This field defaults to “ON_DEMAND” and is ignored, when specified for insert requests.
WindowStartTime string
The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
instance string
Name of the database instance.
backupKind BackupRunBackupKind
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description string
The description of this run, only applicable to on-demand backups.
diskEncryptionConfiguration DiskEncryptionConfigurationArgs
Encryption configuration specific to a backup.
diskEncryptionStatus DiskEncryptionStatusArgs
Encryption status specific to a backup.
endTime string
The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueuedTime string
The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error OperationErrorArgs
Information about why the backup operation failed. This is only present if the run has the FAILED status.
id string
The identifier for this backup run. Unique only for a specific Cloud SQL instance.
kind string
This is always sql#backupRun.
location string
Location of the backups.
project string
selfLink string
The URI of this resource.
startTime string
The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status BackupRunStatus
The status of this run.
type BackupRunType
The type of this run; can be either “AUTOMATED” or “ON_DEMAND”. This field defaults to “ON_DEMAND” and is ignored, when specified for insert requests.
windowStartTime string
The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
instance str
Name of the database instance.
backup_kind BackupRunBackupKind
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
description str
The description of this run, only applicable to on-demand backups.
disk_encryption_configuration DiskEncryptionConfigurationArgs
Encryption configuration specific to a backup.
disk_encryption_status DiskEncryptionStatusArgs
Encryption status specific to a backup.
end_time str
The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
enqueued_time str
The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
error OperationErrorArgs
Information about why the backup operation failed. This is only present if the run has the FAILED status.
id str
The identifier for this backup run. Unique only for a specific Cloud SQL instance.
kind str
This is always sql#backupRun.
location str
Location of the backups.
project str
self_link str
The URI of this resource.
start_time str
The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
status BackupRunStatus
The status of this run.
type BackupRunType
The type of this run; can be either “AUTOMATED” or “ON_DEMAND”. This field defaults to “ON_DEMAND” and is ignored, when specified for insert requests.
window_start_time str
The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Supporting Types

BackupRunBackupKind

SqlBackupKindUnspecified
SQL_BACKUP_KIND_UNSPECIFIEDThis is an unknown BackupKind.
Snapshot
SNAPSHOTThe snapshot based backups
Physical
PHYSICALPhysical backups
BackupRunBackupKindSqlBackupKindUnspecified
SQL_BACKUP_KIND_UNSPECIFIEDThis is an unknown BackupKind.
BackupRunBackupKindSnapshot
SNAPSHOTThe snapshot based backups
BackupRunBackupKindPhysical
PHYSICALPhysical backups
SqlBackupKindUnspecified
SQL_BACKUP_KIND_UNSPECIFIEDThis is an unknown BackupKind.
Snapshot
SNAPSHOTThe snapshot based backups
Physical
PHYSICALPhysical backups
SQL_BACKUP_KIND_UNSPECIFIED
SQL_BACKUP_KIND_UNSPECIFIEDThis is an unknown BackupKind.
SNAPSHOT
SNAPSHOTThe snapshot based backups
PHYSICAL
PHYSICALPhysical backups

BackupRunStatus

SqlBackupRunStatusUnspecified
SQL_BACKUP_RUN_STATUS_UNSPECIFIEDThe status of the run is unknown.
Enqueued
ENQUEUEDThe backup operation was enqueued.
Overdue
OVERDUEThe backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
Running
RUNNINGThe backup is in progress.
Failed
FAILEDThe backup failed.
Successful
SUCCESSFULThe backup was successful.
Skipped
SKIPPEDThe backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DeletionPending
DELETION_PENDINGThe backup is about to be deleted.
DeletionFailed
DELETION_FAILEDThe backup deletion failed.
Deleted
DELETEDThe backup has been deleted.
BackupRunStatusSqlBackupRunStatusUnspecified
SQL_BACKUP_RUN_STATUS_UNSPECIFIEDThe status of the run is unknown.
BackupRunStatusEnqueued
ENQUEUEDThe backup operation was enqueued.
BackupRunStatusOverdue
OVERDUEThe backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
BackupRunStatusRunning
RUNNINGThe backup is in progress.
BackupRunStatusFailed
FAILEDThe backup failed.
BackupRunStatusSuccessful
SUCCESSFULThe backup was successful.
BackupRunStatusSkipped
SKIPPEDThe backup was skipped (without problems) for a given backup window. Example: Instance was idle.
BackupRunStatusDeletionPending
DELETION_PENDINGThe backup is about to be deleted.
BackupRunStatusDeletionFailed
DELETION_FAILEDThe backup deletion failed.
BackupRunStatusDeleted
DELETEDThe backup has been deleted.
SqlBackupRunStatusUnspecified
SQL_BACKUP_RUN_STATUS_UNSPECIFIEDThe status of the run is unknown.
Enqueued
ENQUEUEDThe backup operation was enqueued.
Overdue
OVERDUEThe backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
Running
RUNNINGThe backup is in progress.
Failed
FAILEDThe backup failed.
Successful
SUCCESSFULThe backup was successful.
Skipped
SKIPPEDThe backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DeletionPending
DELETION_PENDINGThe backup is about to be deleted.
DeletionFailed
DELETION_FAILEDThe backup deletion failed.
Deleted
DELETEDThe backup has been deleted.
SQL_BACKUP_RUN_STATUS_UNSPECIFIED
SQL_BACKUP_RUN_STATUS_UNSPECIFIEDThe status of the run is unknown.
ENQUEUED
ENQUEUEDThe backup operation was enqueued.
OVERDUE
OVERDUEThe backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window.
RUNNING
RUNNINGThe backup is in progress.
FAILED
FAILEDThe backup failed.
SUCCESSFUL
SUCCESSFULThe backup was successful.
SKIPPED
SKIPPEDThe backup was skipped (without problems) for a given backup window. Example: Instance was idle.
DELETION_PENDING
DELETION_PENDINGThe backup is about to be deleted.
DELETION_FAILED
DELETION_FAILEDThe backup deletion failed.
DELETED
DELETEDThe backup has been deleted.

BackupRunType

SqlBackupRunTypeUnspecified
SQL_BACKUP_RUN_TYPE_UNSPECIFIEDThis is an unknown BackupRun type.
Automated
AUTOMATEDThe backup schedule automatically triggers a backup.
OnDemand
ON_DEMANDThe user manually triggers a backup.
BackupRunTypeSqlBackupRunTypeUnspecified
SQL_BACKUP_RUN_TYPE_UNSPECIFIEDThis is an unknown BackupRun type.
BackupRunTypeAutomated
AUTOMATEDThe backup schedule automatically triggers a backup.
BackupRunTypeOnDemand
ON_DEMANDThe user manually triggers a backup.
SqlBackupRunTypeUnspecified
SQL_BACKUP_RUN_TYPE_UNSPECIFIEDThis is an unknown BackupRun type.
Automated
AUTOMATEDThe backup schedule automatically triggers a backup.
OnDemand
ON_DEMANDThe user manually triggers a backup.
SQL_BACKUP_RUN_TYPE_UNSPECIFIED
SQL_BACKUP_RUN_TYPE_UNSPECIFIEDThis is an unknown BackupRun type.
AUTOMATED
AUTOMATEDThe backup schedule automatically triggers a backup.
ON_DEMAND
ON_DEMANDThe user manually triggers a backup.

DiskEncryptionConfiguration

Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
kind string
This is always sql#diskEncryptionConfiguration.
kmsKeyName string
Resource name of KMS key for disk encryption
kind str
This is always sql#diskEncryptionConfiguration.
kms_key_name str
Resource name of KMS key for disk encryption

DiskEncryptionConfigurationResponse

Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
Kind string
This is always sql#diskEncryptionConfiguration.
KmsKeyName string
Resource name of KMS key for disk encryption
kind string
This is always sql#diskEncryptionConfiguration.
kmsKeyName string
Resource name of KMS key for disk encryption
kind str
This is always sql#diskEncryptionConfiguration.
kms_key_name str
Resource name of KMS key for disk encryption

DiskEncryptionStatus

Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind string
This is always sql#diskEncryptionStatus.
kmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind str
This is always sql#diskEncryptionStatus.
kms_key_version_name str
KMS key version used to encrypt the Cloud SQL instance resource

DiskEncryptionStatusResponse

Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
Kind string
This is always sql#diskEncryptionStatus.
KmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind string
This is always sql#diskEncryptionStatus.
kmsKeyVersionName string
KMS key version used to encrypt the Cloud SQL instance resource
kind str
This is always sql#diskEncryptionStatus.
kms_key_version_name str
KMS key version used to encrypt the Cloud SQL instance resource

OperationError

Code string
Identifies the specific error that occurred.
Kind string
This is always sql#operationError.
Message string
Additional information about the error encountered.
Code string
Identifies the specific error that occurred.
Kind string
This is always sql#operationError.
Message string
Additional information about the error encountered.
code string
Identifies the specific error that occurred.
kind string
This is always sql#operationError.
message string
Additional information about the error encountered.
code str
Identifies the specific error that occurred.
kind str
This is always sql#operationError.
message str
Additional information about the error encountered.

OperationErrorResponse

Code string
Identifies the specific error that occurred.
Kind string
This is always sql#operationError.
Message string
Additional information about the error encountered.
Code string
Identifies the specific error that occurred.
Kind string
This is always sql#operationError.
Message string
Additional information about the error encountered.
code string
Identifies the specific error that occurred.
kind string
This is always sql#operationError.
message string
Additional information about the error encountered.
code str
Identifies the specific error that occurred.
kind str
This is always sql#operationError.
message str
Additional information about the error encountered.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0