Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. sqladmin
  5. sqladmin/v1beta4
  6. BackupRun

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.sqladmin/v1beta4.BackupRun

Explore with Pulumi AI

google-native logo

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

    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.

    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.DiskEncryptionConfiguration

    Encryption configuration specific to a backup.

    DiskEncryptionStatus Pulumi.GoogleNative.SQLAdmin.V1Beta4.Inputs.DiskEncryptionStatus

    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.OperationError

    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.

    TimeZone string

    Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

    Type Pulumi.GoogleNative.SQLAdmin.V1Beta4.BackupRunType

    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.

    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.

    TimeZone string

    Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

    Type BackupRunType

    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.

    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 DiskEncryptionConfiguration

    Encryption configuration specific to a backup.

    diskEncryptionStatus DiskEncryptionStatus

    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 OperationError

    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.

    timeZone String

    Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

    type BackupRunType

    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.

    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 DiskEncryptionConfiguration

    Encryption configuration specific to a backup.

    diskEncryptionStatus DiskEncryptionStatus

    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 OperationError

    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.

    timeZone string

    Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

    type BackupRunType

    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.

    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.

    time_zone str

    Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

    type BackupRunType

    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_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.

    instance String

    Name of the database instance.

    backupKind "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.

    diskEncryptionConfiguration Property Map

    Encryption configuration specific to a backup.

    diskEncryptionStatus Property Map

    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 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
    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.

    timeZone 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.

    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.

    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.

    Status string

    The status of this run.

    Id string

    The provider-assigned unique ID for this managed resource.

    Status string

    The status of this run.

    id String

    The provider-assigned unique ID for this managed resource.

    status String

    The status of this run.

    id string

    The provider-assigned unique ID for this managed resource.

    status string

    The status of this run.

    id str

    The provider-assigned unique ID for this managed resource.

    status str

    The status of this run.

    id String

    The provider-assigned unique ID for this managed resource.

    status String

    The status of this run.

    Supporting Types

    BackupRunBackupKind, BackupRunBackupKindArgs

    SqlBackupKindUnspecified
    SQL_BACKUP_KIND_UNSPECIFIED

    This is an unknown BackupKind.

    Snapshot
    SNAPSHOT

    The snapshot based backups

    Physical
    PHYSICAL

    Physical backups

    BackupRunBackupKindSqlBackupKindUnspecified
    SQL_BACKUP_KIND_UNSPECIFIED

    This is an unknown BackupKind.

    BackupRunBackupKindSnapshot
    SNAPSHOT

    The snapshot based backups

    BackupRunBackupKindPhysical
    PHYSICAL

    Physical backups

    SqlBackupKindUnspecified
    SQL_BACKUP_KIND_UNSPECIFIED

    This is an unknown BackupKind.

    Snapshot
    SNAPSHOT

    The snapshot based backups

    Physical
    PHYSICAL

    Physical backups

    SqlBackupKindUnspecified
    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

    SqlBackupRunTypeUnspecified
    SQL_BACKUP_RUN_TYPE_UNSPECIFIED

    This is an unknown BackupRun type.

    Automated
    AUTOMATED

    The backup schedule automatically triggers a backup.

    OnDemand
    ON_DEMAND

    The user manually triggers a backup.

    BackupRunTypeSqlBackupRunTypeUnspecified
    SQL_BACKUP_RUN_TYPE_UNSPECIFIED

    This is an unknown BackupRun type.

    BackupRunTypeAutomated
    AUTOMATED

    The backup schedule automatically triggers a backup.

    BackupRunTypeOnDemand
    ON_DEMAND

    The user manually triggers a backup.

    SqlBackupRunTypeUnspecified
    SQL_BACKUP_RUN_TYPE_UNSPECIFIED

    This is an unknown BackupRun type.

    Automated
    AUTOMATED

    The backup schedule automatically triggers a backup.

    OnDemand
    ON_DEMAND

    The user manually triggers a backup.

    SqlBackupRunTypeUnspecified
    SQL_BACKUP_RUN_TYPE_UNSPECIFIED

    This is an unknown BackupRun type.

    Automated
    AUTOMATED

    The backup schedule automatically triggers a backup.

    OnDemand
    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.

    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 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

    kind String

    This is always sql#diskEncryptionConfiguration.

    kmsKeyName String

    Resource name of KMS key for disk encryption

    DiskEncryptionConfigurationResponse, DiskEncryptionConfigurationResponseArgs

    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 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

    kind String

    This is always sql#diskEncryptionConfiguration.

    kmsKeyName String

    Resource name of KMS key for disk encryption

    DiskEncryptionStatus, DiskEncryptionStatusArgs

    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 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

    kind String

    This is always sql#diskEncryptionStatus.

    kmsKeyVersionName String

    KMS key version used to encrypt the Cloud SQL instance resource

    DiskEncryptionStatusResponse, DiskEncryptionStatusResponseArgs

    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 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

    kind String

    This is always sql#diskEncryptionStatus.

    kmsKeyVersionName String

    KMS key version used to encrypt the Cloud SQL instance resource

    OperationError, OperationErrorArgs

    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 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.

    code String

    Identifies the specific error that occurred.

    kind String

    This is always sql#operationError.

    message String

    Additional information about the error encountered.

    OperationErrorResponse, OperationErrorResponseArgs

    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 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.

    code String

    Identifies the specific error that occurred.

    kind String

    This is always sql#operationError.

    message String

    Additional information about the error encountered.

    Package Details

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

    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