Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.sqladmin/v1beta4.BackupRun
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new backup run on demand. Auto-naming is currently not supported for this resource.
Create 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,
time_zone: Optional[str] = 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)
public BackupRun(String name, BackupRunArgs args)
public BackupRun(String name, BackupRunArgs args, CustomResourceOptions options)
type: google-native:sqladmin/v1beta4:BackupRun
properties: # The arguments to resource properties.
options: # 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.
- 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.
- name String
- The unique name of the resource.
- args BackupRunArgs
- The arguments to resource properties.
- options 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.
- Backup
Kind Pulumi.Google Native. SQLAdmin. V1Beta4. Backup Run Backup Kind Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- Description string
The description of this run, only applicable to on-demand backups.
- Disk
Encryption Pulumi.Configuration Google Native. SQLAdmin. V1Beta4. Inputs. Disk Encryption Configuration Encryption configuration specific to a backup.
- Disk
Encryption Pulumi.Status Google Native. SQLAdmin. V1Beta4. Inputs. Disk Encryption Status Encryption status specific to a backup.
- End
Time string The time the backup operation completed in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Enqueued
Time string The time the run was enqueued in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Error
Pulumi.
Google Native. SQLAdmin. V1Beta4. Inputs. Operation Error 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
- Self
Link string The URI of this resource.
- Start
Time string The time the backup operation actually started in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Time
Zone string Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- Type
Pulumi.
Google Native. SQLAdmin. V1Beta4. Backup Run Type The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- Window
Start stringTime 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.
- Backup
Kind BackupRun Backup Kind Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- Description string
The description of this run, only applicable to on-demand backups.
- Disk
Encryption DiskConfiguration Encryption Configuration Args Encryption configuration specific to a backup.
- Disk
Encryption DiskStatus Encryption Status Args Encryption status specific to a backup.
- End
Time string The time the backup operation completed in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Enqueued
Time string The time the run was enqueued in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Error
Operation
Error Args 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
- Self
Link string The URI of this resource.
- Start
Time string The time the backup operation actually started in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- Time
Zone string Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- Type
Backup
Run Type The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- Window
Start stringTime 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.
- backup
Kind BackupRun Backup Kind Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- description String
The description of this run, only applicable to on-demand backups.
- disk
Encryption DiskConfiguration Encryption Configuration Encryption configuration specific to a backup.
- disk
Encryption DiskStatus Encryption Status Encryption status specific to a backup.
- end
Time String The time the backup operation completed in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- enqueued
Time String The time the run was enqueued in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- error
Operation
Error 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
- self
Link String The URI of this resource.
- start
Time String The time the backup operation actually started in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- time
Zone String Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- type
Backup
Run Type The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- window
Start StringTime 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.
- backup
Kind BackupRun Backup Kind Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- description string
The description of this run, only applicable to on-demand backups.
- disk
Encryption DiskConfiguration Encryption Configuration Encryption configuration specific to a backup.
- disk
Encryption DiskStatus Encryption Status Encryption status specific to a backup.
- end
Time string The time the backup operation completed in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- enqueued
Time string The time the run was enqueued in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- error
Operation
Error 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
- self
Link string The URI of this resource.
- start
Time string The time the backup operation actually started in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- time
Zone string Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- type
Backup
Run Type The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- window
Start stringTime 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 BackupRun Backup Kind Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- description str
The description of this run, only applicable to on-demand backups.
- disk_
encryption_ Diskconfiguration Encryption Configuration Args Encryption configuration specific to a backup.
- disk_
encryption_ Diskstatus Encryption Status Args 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
Operation
Error Args 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
.- time_
zone str Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- type
Backup
Run Type The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- window_
start_ strtime 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.
- backup
Kind "SQL_BACKUP_KIND_UNSPECIFIED" | "SNAPSHOT" | "PHYSICAL" Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
- description String
The description of this run, only applicable to on-demand backups.
- disk
Encryption Property MapConfiguration Encryption configuration specific to a backup.
- disk
Encryption Property MapStatus Encryption status specific to a backup.
- end
Time String The time the backup operation completed in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- enqueued
Time String The time the run was enqueued in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- error Property Map
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
- self
Link String The URI of this resource.
- start
Time String The time the backup operation actually started in UTC timezone in RFC 3339 format, for example
2012-11-15T16:19:00.094Z
.- time
Zone String Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
- type "SQL_BACKUP_RUN_TYPE_UNSPECIFIED" | "AUTOMATED" | "ON_DEMAND"
The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
- window
Start StringTime 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:
Supporting Types
BackupRunBackupKind, BackupRunBackupKindArgs
- Sql
Backup Kind Unspecified - SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- Snapshot
- SNAPSHOT
The snapshot based backups
- Physical
- PHYSICAL
Physical backups
- Backup
Run Backup Kind Sql Backup Kind Unspecified - SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- Backup
Run Backup Kind Snapshot - SNAPSHOT
The snapshot based backups
- Backup
Run Backup Kind Physical - PHYSICAL
Physical backups
- Sql
Backup Kind Unspecified - SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- Snapshot
- SNAPSHOT
The snapshot based backups
- Physical
- PHYSICAL
Physical backups
- Sql
Backup Kind Unspecified - SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- Snapshot
- SNAPSHOT
The snapshot based backups
- Physical
- PHYSICAL
Physical backups
- SQL_BACKUP_KIND_UNSPECIFIED
- SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- SNAPSHOT
- SNAPSHOT
The snapshot based backups
- PHYSICAL
- PHYSICAL
Physical backups
- "SQL_BACKUP_KIND_UNSPECIFIED"
- SQL_BACKUP_KIND_UNSPECIFIED
This is an unknown BackupKind.
- "SNAPSHOT"
- SNAPSHOT
The snapshot based backups
- "PHYSICAL"
- PHYSICAL
Physical backups
BackupRunType, BackupRunTypeArgs
- Sql
Backup Run Type Unspecified - SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- Automated
- AUTOMATED
The backup schedule automatically triggers a backup.
- On
Demand - ON_DEMAND
The user manually triggers a backup.
- Backup
Run Type Sql Backup Run Type Unspecified - SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- Backup
Run Type Automated - AUTOMATED
The backup schedule automatically triggers a backup.
- Backup
Run Type On Demand - ON_DEMAND
The user manually triggers a backup.
- Sql
Backup Run Type Unspecified - SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- Automated
- AUTOMATED
The backup schedule automatically triggers a backup.
- On
Demand - ON_DEMAND
The user manually triggers a backup.
- Sql
Backup Run Type Unspecified - SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- Automated
- AUTOMATED
The backup schedule automatically triggers a backup.
- On
Demand - ON_DEMAND
The user manually triggers a backup.
- SQL_BACKUP_RUN_TYPE_UNSPECIFIED
- SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- AUTOMATED
- AUTOMATED
The backup schedule automatically triggers a backup.
- ON_DEMAND
- ON_DEMAND
The user manually triggers a backup.
- "SQL_BACKUP_RUN_TYPE_UNSPECIFIED"
- SQL_BACKUP_RUN_TYPE_UNSPECIFIED
This is an unknown BackupRun type.
- "AUTOMATED"
- AUTOMATED
The backup schedule automatically triggers a backup.
- "ON_DEMAND"
- ON_DEMAND
The user manually triggers a backup.
DiskEncryptionConfiguration, DiskEncryptionConfigurationArgs
- Kind string
This is always
sql#diskEncryptionConfiguration
.- Kms
Key stringName Resource name of KMS key for disk encryption
- Kind string
This is always
sql#diskEncryptionConfiguration
.- Kms
Key stringName Resource name of KMS key for disk encryption
- kind String
This is always
sql#diskEncryptionConfiguration
.- kms
Key StringName Resource name of KMS key for disk encryption
- kind string
This is always
sql#diskEncryptionConfiguration
.- kms
Key stringName Resource name of KMS key for disk encryption
- kind str
This is always
sql#diskEncryptionConfiguration
.- kms_
key_ strname Resource name of KMS key for disk encryption
- kind String
This is always
sql#diskEncryptionConfiguration
.- kms
Key StringName Resource name of KMS key for disk encryption
DiskEncryptionConfigurationResponse, DiskEncryptionConfigurationResponseArgs
- Kind string
This is always
sql#diskEncryptionConfiguration
.- Kms
Key stringName Resource name of KMS key for disk encryption
- Kind string
This is always
sql#diskEncryptionConfiguration
.- Kms
Key stringName Resource name of KMS key for disk encryption
- kind String
This is always
sql#diskEncryptionConfiguration
.- kms
Key StringName Resource name of KMS key for disk encryption
- kind string
This is always
sql#diskEncryptionConfiguration
.- kms
Key stringName Resource name of KMS key for disk encryption
- kind str
This is always
sql#diskEncryptionConfiguration
.- kms_
key_ strname Resource name of KMS key for disk encryption
- kind String
This is always
sql#diskEncryptionConfiguration
.- kms
Key StringName Resource name of KMS key for disk encryption
DiskEncryptionStatus, DiskEncryptionStatusArgs
- Kind string
This is always
sql#diskEncryptionStatus
.- Kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- Kind string
This is always
sql#diskEncryptionStatus
.- Kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind String
This is always
sql#diskEncryptionStatus
.- kms
Key StringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind string
This is always
sql#diskEncryptionStatus
.- kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind str
This is always
sql#diskEncryptionStatus
.- kms_
key_ strversion_ name KMS key version used to encrypt the Cloud SQL instance resource
- kind String
This is always
sql#diskEncryptionStatus
.- kms
Key StringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
DiskEncryptionStatusResponse, DiskEncryptionStatusResponseArgs
- Kind string
This is always
sql#diskEncryptionStatus
.- Kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- Kind string
This is always
sql#diskEncryptionStatus
.- Kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind String
This is always
sql#diskEncryptionStatus
.- kms
Key StringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind string
This is always
sql#diskEncryptionStatus
.- kms
Key stringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
- kind str
This is always
sql#diskEncryptionStatus
.- kms_
key_ strversion_ name KMS key version used to encrypt the Cloud SQL instance resource
- kind String
This is always
sql#diskEncryptionStatus
.- kms
Key StringVersion Name KMS key version used to encrypt the Cloud SQL instance resource
OperationError, OperationErrorArgs
OperationErrorResponse, OperationErrorResponseArgs
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.