Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. MysqlBackup
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Mysql.MysqlBackup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Mysql Backup resource in Oracle Cloud Infrastructure MySQL Database service.

    Create a backup of a DB System.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMysqlBackup = new oci.mysql.MysqlBackup("test_mysql_backup", {
    dbSystemId: testDbSystem.id,
    backupType: mysqlBackupBackupType,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: mysqlBackupDescription,
    displayName: mysqlBackupDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
    retentionInDays: mysqlBackupRetentionInDays,
});

    import pulumi
import pulumi_oci as oci

test_mysql_backup = oci.mysql.MysqlBackup("test_mysql_backup",
    db_system_id=test_db_system["id"],
    backup_type=mysql_backup_backup_type,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=mysql_backup_description,
    display_name=mysql_backup_display_name,
    freeform_tags={
        "bar-key": "value",
    },
    retention_in_days=mysql_backup_retention_in_days)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/mysql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mysql.NewMysqlBackup(ctx, "test_mysql_backup", &mysql.MysqlBackupArgs{
			DbSystemId: pulumi.Any(testDbSystem.Id),
			BackupType: pulumi.Any(mysqlBackupBackupType),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(mysqlBackupDescription),
			DisplayName: pulumi.Any(mysqlBackupDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			RetentionInDays: pulumi.Any(mysqlBackupRetentionInDays),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMysqlBackup = new Oci.Mysql.MysqlBackup("test_mysql_backup", new()
    {
        DbSystemId = testDbSystem.Id,
        BackupType = mysqlBackupBackupType,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = mysqlBackupDescription,
        DisplayName = mysqlBackupDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        RetentionInDays = mysqlBackupRetentionInDays,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Mysql.MysqlBackup;
import com.pulumi.oci.Mysql.MysqlBackupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testMysqlBackup = new MysqlBackup("testMysqlBackup", MysqlBackupArgs.builder()
            .dbSystemId(testDbSystem.id())
            .backupType(mysqlBackupBackupType)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(mysqlBackupDescription)
            .displayName(mysqlBackupDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .retentionInDays(mysqlBackupRetentionInDays)
            .build());

    }
}

    resources:
  testMysqlBackup:
    type: oci:Mysql:MysqlBackup
    name: test_mysql_backup
    properties:
      dbSystemId: ${testDbSystem.id}
      backupType: ${mysqlBackupBackupType}
      definedTags:
        foo-namespace.bar-key: value
      description: ${mysqlBackupDescription}
      displayName: ${mysqlBackupDisplayName}
      freeformTags:
        bar-key: value
      retentionInDays: ${mysqlBackupRetentionInDays}

    Create MysqlBackup Resource

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

    Constructor syntax

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

@overload
def MysqlBackup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                backup_type: Optional[str] = None,
                compartment_id: Optional[str] = None,
                db_system_id: Optional[str] = None,
                db_system_snapshot_summaries: Optional[Sequence[MysqlBackupDbSystemSnapshotSummaryArgs]] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                retention_in_days: Optional[int] = None,
                source_details: Optional[MysqlBackupSourceDetailsArgs] = None)
    func NewMysqlBackup(ctx *Context, name string, args *MysqlBackupArgs, opts ...ResourceOption) (*MysqlBackup, error)
    public MysqlBackup(string name, MysqlBackupArgs? args = null, CustomResourceOptions? opts = null)
    public MysqlBackup(String name, MysqlBackupArgs args)
public MysqlBackup(String name, MysqlBackupArgs args, CustomResourceOptions options)

    type: oci:Mysql:MysqlBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MysqlBackupArgs
    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 MysqlBackupArgs
    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 MysqlBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MysqlBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MysqlBackupArgs
    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 mysqlBackupResource = new Oci.Mysql.MysqlBackup("mysqlBackupResource", new()
{
    BackupType = "string",
    CompartmentId = "string",
    DbSystemId = "string",
    DbSystemSnapshotSummaries = new[]
    {
        new Oci.Mysql.Inputs.MysqlBackupDbSystemSnapshotSummaryArgs
        {
            DisplayName = "string",
            Id = "string",
            Region = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    RetentionInDays = 0,
    SourceDetails = new Oci.Mysql.Inputs.MysqlBackupSourceDetailsArgs
    {
        BackupId = "string",
        CompartmentId = "string",
        Region = "string",
    },
});

    example, err := mysql.NewMysqlBackup(ctx, "mysqlBackupResource", &mysql.MysqlBackupArgs{
	BackupType:    pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	DbSystemId:    pulumi.String("string"),
	DbSystemSnapshotSummaries: mysql.MysqlBackupDbSystemSnapshotSummaryArray{
		&mysql.MysqlBackupDbSystemSnapshotSummaryArgs{
			DisplayName: pulumi.String("string"),
			Id:          pulumi.String("string"),
			Region:      pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RetentionInDays: pulumi.Int(0),
	SourceDetails: &mysql.MysqlBackupSourceDetailsArgs{
		BackupId:      pulumi.String("string"),
		CompartmentId: pulumi.String("string"),
		Region:        pulumi.String("string"),
	},
})

    var mysqlBackupResource = new MysqlBackup("mysqlBackupResource", MysqlBackupArgs.builder()
    .backupType("string")
    .compartmentId("string")
    .dbSystemId("string")
    .dbSystemSnapshotSummaries(MysqlBackupDbSystemSnapshotSummaryArgs.builder()
        .displayName("string")
        .id("string")
        .region("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .retentionInDays(0)
    .sourceDetails(MysqlBackupSourceDetailsArgs.builder()
        .backupId("string")
        .compartmentId("string")
        .region("string")
        .build())
    .build());

    mysql_backup_resource = oci.mysql.MysqlBackup("mysqlBackupResource",
    backup_type="string",
    compartment_id="string",
    db_system_id="string",
    db_system_snapshot_summaries=[{
        "display_name": "string",
        "id": "string",
        "region": "string",
    }],
    defined_tags={
        "string": "string",
    },
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    retention_in_days=0,
    source_details={
        "backup_id": "string",
        "compartment_id": "string",
        "region": "string",
    })

    const mysqlBackupResource = new oci.mysql.MysqlBackup("mysqlBackupResource", {
    backupType: "string",
    compartmentId: "string",
    dbSystemId: "string",
    dbSystemSnapshotSummaries: [{
        displayName: "string",
        id: "string",
        region: "string",
    }],
    definedTags: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    retentionInDays: 0,
    sourceDetails: {
        backupId: "string",
        compartmentId: "string",
        region: "string",
    },
});

    type: oci:Mysql:MysqlBackup
properties:
    backupType: string
    compartmentId: string
    dbSystemId: string
    dbSystemSnapshotSummaries:
        - displayName: string
          id: string
          region: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    retentionInDays: 0
    sourceDetails:
        backupId: string
        compartmentId: string
        region: string

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

    BackupType string
    The type of backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    DbSystemId string
    The OCID of the DB System the Backup is associated with.
    DbSystemSnapshotSummaries List<MysqlBackupDbSystemSnapshotSummary>
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    SourceDetails MysqlBackupSourceDetails
    Details of backup source in the cloud.
    BackupType string
    The type of backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    DbSystemId string
    The OCID of the DB System the Backup is associated with.
    DbSystemSnapshotSummaries []MysqlBackupDbSystemSnapshotSummaryArgs
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    SourceDetails MysqlBackupSourceDetailsArgs
    Details of backup source in the cloud.
    backupType String
    The type of backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    dbSystemId String
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries List<BackupDbSystemSnapshotSummary>
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionInDays Integer
    (Updatable) Number of days to retain this backup.
    sourceDetails BackupSourceDetails
    Details of backup source in the cloud.
    backupType string
    The type of backup.
    compartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    dbSystemId string
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries MysqlBackupDbSystemSnapshotSummary[]
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) A user-supplied description for the backup.
    displayName string
    (Updatable) A user-supplied display name for the backup.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionInDays number
    (Updatable) Number of days to retain this backup.
    sourceDetails MysqlBackupSourceDetails
    Details of backup source in the cloud.
    backup_type str
    The type of backup.
    compartment_id str
    (Updatable) The OCID of the compartment the backup exists in.
    db_system_id str
    The OCID of the DB System the Backup is associated with.
    db_system_snapshot_summaries Sequence[MysqlBackupDbSystemSnapshotSummaryArgs]
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) A user-supplied description for the backup.
    display_name str
    (Updatable) A user-supplied display name for the backup.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retention_in_days int
    (Updatable) Number of days to retain this backup.
    source_details MysqlBackupSourceDetailsArgs
    Details of backup source in the cloud.
    backupType String
    The type of backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    dbSystemId String
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries List<Property Map>
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    retentionInDays Number
    (Updatable) Number of days to retain this backup.
    sourceDetails Property Map
    Details of backup source in the cloud.

    Outputs

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

    BackupSizeInGbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    CreationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DbSystemSnapshots List<MysqlBackupDbSystemSnapshot>
    Snapshot of the DbSystem details at the time of the backup
    Id string
    The provider-assigned unique ID for this managed resource.
    ImmediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    OriginalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    ShapeName string
    The shape of the DB System instance used for backup.
    State string
    The state of the backup.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    TimeCreated string
    The time the backup record was created.
    TimeUpdated string
    The time at which the backup was updated.
    BackupSizeInGbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    CreationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DbSystemSnapshots []MysqlBackupDbSystemSnapshot
    Snapshot of the DbSystem details at the time of the backup
    Id string
    The provider-assigned unique ID for this managed resource.
    ImmediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    OriginalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    ShapeName string
    The shape of the DB System instance used for backup.
    State string
    The state of the backup.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    TimeCreated string
    The time the backup record was created.
    TimeUpdated string
    The time at which the backup was updated.
    backupSizeInGbs Integer
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    creationType String
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb Integer
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemSnapshots List<BackupDbSystemSnapshot>
    Snapshot of the DbSystem details at the time of the backup
    id String
    The provider-assigned unique ID for this managed resource.
    immediateSourceBackupId String
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId String
    The OCID of the original source DB system backup from which this DB system backup was copied.
    shapeName String
    The shape of the DB System instance used for backup.
    state String
    The state of the backup.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated String
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated String
    The time the backup record was created.
    timeUpdated String
    The time at which the backup was updated.
    backupSizeInGbs number
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    creationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemSnapshots MysqlBackupDbSystemSnapshot[]
    Snapshot of the DbSystem details at the time of the backup
    id string
    The provider-assigned unique ID for this managed resource.
    immediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails string
    Additional information about the current lifecycleState.
    mysqlVersion string
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    shapeName string
    The shape of the DB System instance used for backup.
    state string
    The state of the backup.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated string
    The time the backup record was created.
    timeUpdated string
    The time at which the backup was updated.
    backup_size_in_gbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    creation_type str
    Indicates how the backup was created: manually, automatic, or by an Operator.
    data_storage_size_in_gb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    db_system_snapshots Sequence[MysqlBackupDbSystemSnapshot]
    Snapshot of the DbSystem details at the time of the backup
    id str
    The provider-assigned unique ID for this managed resource.
    immediate_source_backup_id str
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycle_details str
    Additional information about the current lifecycleState.
    mysql_version str
    The MySQL server version of the DB System used for backup.
    original_source_backup_id str
    The OCID of the original source DB system backup from which this DB system backup was copied.
    shape_name str
    The shape of the DB System instance used for backup.
    state str
    The state of the backup.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_copy_created str
    The date and time the DB system backup copy was created, as described by RFC 3339.
    time_created str
    The time the backup record was created.
    time_updated str
    The time at which the backup was updated.
    backupSizeInGbs Number
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    creationType String
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb Number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemSnapshots List<Property Map>
    Snapshot of the DbSystem details at the time of the backup
    id String
    The provider-assigned unique ID for this managed resource.
    immediateSourceBackupId String
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId String
    The OCID of the original source DB system backup from which this DB system backup was copied.
    shapeName String
    The shape of the DB System instance used for backup.
    state String
    The state of the backup.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated String
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated String
    The time the backup record was created.
    timeUpdated String
    The time at which the backup was updated.

    Look up Existing MysqlBackup Resource

    Get an existing MysqlBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MysqlBackupState, opts?: CustomResourceOptions): MysqlBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_size_in_gbs: Optional[int] = None,
        backup_type: Optional[str] = None,
        compartment_id: Optional[str] = None,
        creation_type: Optional[str] = None,
        data_storage_size_in_gb: Optional[int] = None,
        db_system_id: Optional[str] = None,
        db_system_snapshot_summaries: Optional[Sequence[MysqlBackupDbSystemSnapshotSummaryArgs]] = None,
        db_system_snapshots: Optional[Sequence[MysqlBackupDbSystemSnapshotArgs]] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        immediate_source_backup_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        mysql_version: Optional[str] = None,
        original_source_backup_id: Optional[str] = None,
        retention_in_days: Optional[int] = None,
        shape_name: Optional[str] = None,
        source_details: Optional[MysqlBackupSourceDetailsArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_copy_created: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> MysqlBackup
    func GetMysqlBackup(ctx *Context, name string, id IDInput, state *MysqlBackupState, opts ...ResourceOption) (*MysqlBackup, error)
    public static MysqlBackup Get(string name, Input<string> id, MysqlBackupState? state, CustomResourceOptions? opts = null)
    public static MysqlBackup get(String name, Output<String> id, MysqlBackupState state, CustomResourceOptions options)
    resources:  _:    type: oci:Mysql:MysqlBackup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BackupSizeInGbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    BackupType string
    The type of backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    CreationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DbSystemId string
    The OCID of the DB System the Backup is associated with.
    DbSystemSnapshotSummaries List<MysqlBackupDbSystemSnapshotSummary>
    DbSystemSnapshots List<MysqlBackupDbSystemSnapshot>
    Snapshot of the DbSystem details at the time of the backup
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ImmediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    OriginalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    ShapeName string
    The shape of the DB System instance used for backup.
    SourceDetails MysqlBackupSourceDetails
    Details of backup source in the cloud.
    State string
    The state of the backup.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    TimeCreated string
    The time the backup record was created.
    TimeUpdated string
    The time at which the backup was updated.
    BackupSizeInGbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    BackupType string
    The type of backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    CreationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DbSystemId string
    The OCID of the DB System the Backup is associated with.
    DbSystemSnapshotSummaries []MysqlBackupDbSystemSnapshotSummaryArgs
    DbSystemSnapshots []MysqlBackupDbSystemSnapshotArgs
    Snapshot of the DbSystem details at the time of the backup
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ImmediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    LifecycleDetails string
    Additional information about the current lifecycleState.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    OriginalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    ShapeName string
    The shape of the DB System instance used for backup.
    SourceDetails MysqlBackupSourceDetailsArgs
    Details of backup source in the cloud.
    State string
    The state of the backup.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    TimeCreated string
    The time the backup record was created.
    TimeUpdated string
    The time at which the backup was updated.
    backupSizeInGbs Integer
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    backupType String
    The type of backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    creationType String
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb Integer
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemId String
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries List<BackupDbSystemSnapshotSummary>
    dbSystemSnapshots List<BackupDbSystemSnapshot>
    Snapshot of the DbSystem details at the time of the backup
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    immediateSourceBackupId String
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId String
    The OCID of the original source DB system backup from which this DB system backup was copied.
    retentionInDays Integer
    (Updatable) Number of days to retain this backup.
    shapeName String
    The shape of the DB System instance used for backup.
    sourceDetails BackupSourceDetails
    Details of backup source in the cloud.
    state String
    The state of the backup.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated String
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated String
    The time the backup record was created.
    timeUpdated String
    The time at which the backup was updated.
    backupSizeInGbs number
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    backupType string
    The type of backup.
    compartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    creationType string
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemId string
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries MysqlBackupDbSystemSnapshotSummary[]
    dbSystemSnapshots MysqlBackupDbSystemSnapshot[]
    Snapshot of the DbSystem details at the time of the backup
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) A user-supplied description for the backup.
    displayName string
    (Updatable) A user-supplied display name for the backup.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    immediateSourceBackupId string
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails string
    Additional information about the current lifecycleState.
    mysqlVersion string
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId string
    The OCID of the original source DB system backup from which this DB system backup was copied.
    retentionInDays number
    (Updatable) Number of days to retain this backup.
    shapeName string
    The shape of the DB System instance used for backup.
    sourceDetails MysqlBackupSourceDetails
    Details of backup source in the cloud.
    state string
    The state of the backup.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated string
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated string
    The time the backup record was created.
    timeUpdated string
    The time at which the backup was updated.
    backup_size_in_gbs int
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    backup_type str
    The type of backup.
    compartment_id str
    (Updatable) The OCID of the compartment the backup exists in.
    creation_type str
    Indicates how the backup was created: manually, automatic, or by an Operator.
    data_storage_size_in_gb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    db_system_id str
    The OCID of the DB System the Backup is associated with.
    db_system_snapshot_summaries Sequence[MysqlBackupDbSystemSnapshotSummaryArgs]
    db_system_snapshots Sequence[MysqlBackupDbSystemSnapshotArgs]
    Snapshot of the DbSystem details at the time of the backup
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) A user-supplied description for the backup.
    display_name str
    (Updatable) A user-supplied display name for the backup.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    immediate_source_backup_id str
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycle_details str
    Additional information about the current lifecycleState.
    mysql_version str
    The MySQL server version of the DB System used for backup.
    original_source_backup_id str
    The OCID of the original source DB system backup from which this DB system backup was copied.
    retention_in_days int
    (Updatable) Number of days to retain this backup.
    shape_name str
    The shape of the DB System instance used for backup.
    source_details MysqlBackupSourceDetailsArgs
    Details of backup source in the cloud.
    state str
    The state of the backup.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_copy_created str
    The date and time the DB system backup copy was created, as described by RFC 3339.
    time_created str
    The time the backup record was created.
    time_updated str
    The time at which the backup was updated.
    backupSizeInGbs Number
    The size of the backup in base-2 (IEC) gibibytes. (GiB).
    backupType String
    The type of backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    creationType String
    Indicates how the backup was created: manually, automatic, or by an Operator.
    dataStorageSizeInGb Number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dbSystemId String
    The OCID of the DB System the Backup is associated with.
    dbSystemSnapshotSummaries List<Property Map>
    dbSystemSnapshots List<Property Map>
    Snapshot of the DbSystem details at the time of the backup
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    immediateSourceBackupId String
    The OCID of the immediate source DB system backup from which this DB system backup was copied.
    lifecycleDetails String
    Additional information about the current lifecycleState.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    originalSourceBackupId String
    The OCID of the original source DB system backup from which this DB system backup was copied.
    retentionInDays Number
    (Updatable) Number of days to retain this backup.
    shapeName String
    The shape of the DB System instance used for backup.
    sourceDetails Property Map
    Details of backup source in the cloud.
    state String
    The state of the backup.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCopyCreated String
    The date and time the DB system backup copy was created, as described by RFC 3339.
    timeCreated String
    The time the backup record was created.
    timeUpdated String
    The time at which the backup was updated.

    Supporting Types

    MysqlBackupDbSystemSnapshot, MysqlBackupDbSystemSnapshotArgs

    AdminUsername string
    The username for the administrative user.
    AvailabilityDomain string
    The Availability Domain where the primary DB System should be located.
    BackupPolicies List<MysqlBackupDbSystemSnapshotBackupPolicy>
    The Backup policy for the DB System.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    ConfigurationId string
    The OCID of the Configuration to be used for Instances in this DB System.
    CrashRecovery string
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DataStorages List<MysqlBackupDbSystemSnapshotDataStorage>
    Data Storage information.
    DatabaseManagement string
    Whether to enable monitoring via the Database Management service.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeletionPolicies List<MysqlBackupDbSystemSnapshotDeletionPolicy>
    The Deletion policy for the DB System.
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    Endpoints List<MysqlBackupDbSystemSnapshotEndpoint>
    The network endpoints available for this DB System.
    FaultDomain string
    The name of the Fault Domain the DB System is located in.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HostnameLabel string
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    Id string
    OCID of the backup itself
    IpAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    IsHighlyAvailable bool
    Specifies if the DB System is highly available.
    Maintenances List<MysqlBackupDbSystemSnapshotMaintenance>
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    Port int
    The port for primary endpoint of the DB System to listen on.
    PortX int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    ReadEndpoints List<MysqlBackupDbSystemSnapshotReadEndpoint>
    The read endpoint of a DB System.
    Region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    SecureConnections List<MysqlBackupDbSystemSnapshotSecureConnection>
    Secure connection configuration details.
    ShapeName string
    The shape of the DB System instance used for backup.
    SubnetId string
    The OCID of the subnet the DB System is associated with.
    AdminUsername string
    The username for the administrative user.
    AvailabilityDomain string
    The Availability Domain where the primary DB System should be located.
    BackupPolicies []MysqlBackupDbSystemSnapshotBackupPolicy
    The Backup policy for the DB System.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    ConfigurationId string
    The OCID of the Configuration to be used for Instances in this DB System.
    CrashRecovery string
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DataStorages []MysqlBackupDbSystemSnapshotDataStorage
    Data Storage information.
    DatabaseManagement string
    Whether to enable monitoring via the Database Management service.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeletionPolicies []MysqlBackupDbSystemSnapshotDeletionPolicy
    The Deletion policy for the DB System.
    Description string
    (Updatable) A user-supplied description for the backup.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    Endpoints []MysqlBackupDbSystemSnapshotEndpoint
    The network endpoints available for this DB System.
    FaultDomain string
    The name of the Fault Domain the DB System is located in.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HostnameLabel string
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    Id string
    OCID of the backup itself
    IpAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    IsHighlyAvailable bool
    Specifies if the DB System is highly available.
    Maintenances []MysqlBackupDbSystemSnapshotMaintenance
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    MysqlVersion string
    The MySQL server version of the DB System used for backup.
    Port int
    The port for primary endpoint of the DB System to listen on.
    PortX int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    ReadEndpoints []MysqlBackupDbSystemSnapshotReadEndpoint
    The read endpoint of a DB System.
    Region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    SecureConnections []MysqlBackupDbSystemSnapshotSecureConnection
    Secure connection configuration details.
    ShapeName string
    The shape of the DB System instance used for backup.
    SubnetId string
    The OCID of the subnet the DB System is associated with.
    adminUsername String
    The username for the administrative user.
    availabilityDomain String
    The Availability Domain where the primary DB System should be located.
    backupPolicies List<BackupDbSystemSnapshotBackupPolicy>
    The Backup policy for the DB System.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    configurationId String
    The OCID of the Configuration to be used for Instances in this DB System.
    crashRecovery String
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    dataStorageSizeInGb Integer
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorages List<BackupDbSystemSnapshotDataStorage>
    Data Storage information.
    databaseManagement String
    Whether to enable monitoring via the Database Management service.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deletionPolicies List<BackupDbSystemSnapshotDeletionPolicy>
    The Deletion policy for the DB System.
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    endpoints List<BackupDbSystemSnapshotEndpoint>
    The network endpoints available for this DB System.
    faultDomain String
    The name of the Fault Domain the DB System is located in.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostnameLabel String
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    id String
    OCID of the backup itself
    ipAddress String
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    isHighlyAvailable Boolean
    Specifies if the DB System is highly available.
    maintenances List<BackupDbSystemSnapshotMaintenance>
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    port Integer
    The port for primary endpoint of the DB System to listen on.
    portX Integer
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    readEndpoints List<BackupDbSystemSnapshotReadEndpoint>
    The read endpoint of a DB System.
    region String
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    secureConnections List<BackupDbSystemSnapshotSecureConnection>
    Secure connection configuration details.
    shapeName String
    The shape of the DB System instance used for backup.
    subnetId String
    The OCID of the subnet the DB System is associated with.
    adminUsername string
    The username for the administrative user.
    availabilityDomain string
    The Availability Domain where the primary DB System should be located.
    backupPolicies MysqlBackupDbSystemSnapshotBackupPolicy[]
    The Backup policy for the DB System.
    compartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    configurationId string
    The OCID of the Configuration to be used for Instances in this DB System.
    crashRecovery string
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    dataStorageSizeInGb number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorages MysqlBackupDbSystemSnapshotDataStorage[]
    Data Storage information.
    databaseManagement string
    Whether to enable monitoring via the Database Management service.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deletionPolicies MysqlBackupDbSystemSnapshotDeletionPolicy[]
    The Deletion policy for the DB System.
    description string
    (Updatable) A user-supplied description for the backup.
    displayName string
    (Updatable) A user-supplied display name for the backup.
    endpoints MysqlBackupDbSystemSnapshotEndpoint[]
    The network endpoints available for this DB System.
    faultDomain string
    The name of the Fault Domain the DB System is located in.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostnameLabel string
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    id string
    OCID of the backup itself
    ipAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    isHighlyAvailable boolean
    Specifies if the DB System is highly available.
    maintenances MysqlBackupDbSystemSnapshotMaintenance[]
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    mysqlVersion string
    The MySQL server version of the DB System used for backup.
    port number
    The port for primary endpoint of the DB System to listen on.
    portX number
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    readEndpoints MysqlBackupDbSystemSnapshotReadEndpoint[]
    The read endpoint of a DB System.
    region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    secureConnections MysqlBackupDbSystemSnapshotSecureConnection[]
    Secure connection configuration details.
    shapeName string
    The shape of the DB System instance used for backup.
    subnetId string
    The OCID of the subnet the DB System is associated with.
    admin_username str
    The username for the administrative user.
    availability_domain str
    The Availability Domain where the primary DB System should be located.
    backup_policies Sequence[MysqlBackupDbSystemSnapshotBackupPolicy]
    The Backup policy for the DB System.
    compartment_id str
    (Updatable) The OCID of the compartment the backup exists in.
    configuration_id str
    The OCID of the Configuration to be used for Instances in this DB System.
    crash_recovery str
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    data_storage_size_in_gb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    data_storages Sequence[MysqlBackupDbSystemSnapshotDataStorage]
    Data Storage information.
    database_management str
    Whether to enable monitoring via the Database Management service.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deletion_policies Sequence[MysqlBackupDbSystemSnapshotDeletionPolicy]
    The Deletion policy for the DB System.
    description str
    (Updatable) A user-supplied description for the backup.
    display_name str
    (Updatable) A user-supplied display name for the backup.
    endpoints Sequence[MysqlBackupDbSystemSnapshotEndpoint]
    The network endpoints available for this DB System.
    fault_domain str
    The name of the Fault Domain the DB System is located in.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostname_label str
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    id str
    OCID of the backup itself
    ip_address str
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    is_highly_available bool
    Specifies if the DB System is highly available.
    maintenances Sequence[MysqlBackupDbSystemSnapshotMaintenance]
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    mysql_version str
    The MySQL server version of the DB System used for backup.
    port int
    The port for primary endpoint of the DB System to listen on.
    port_x int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    read_endpoints Sequence[MysqlBackupDbSystemSnapshotReadEndpoint]
    The read endpoint of a DB System.
    region str
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    secure_connections Sequence[MysqlBackupDbSystemSnapshotSecureConnection]
    Secure connection configuration details.
    shape_name str
    The shape of the DB System instance used for backup.
    subnet_id str
    The OCID of the subnet the DB System is associated with.
    adminUsername String
    The username for the administrative user.
    availabilityDomain String
    The Availability Domain where the primary DB System should be located.
    backupPolicies List<Property Map>
    The Backup policy for the DB System.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    configurationId String
    The OCID of the Configuration to be used for Instances in this DB System.
    crashRecovery String
    Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
    dataStorageSizeInGb Number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorages List<Property Map>
    Data Storage information.
    databaseManagement String
    Whether to enable monitoring via the Database Management service.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deletionPolicies List<Property Map>
    The Deletion policy for the DB System.
    description String
    (Updatable) A user-supplied description for the backup.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    endpoints List<Property Map>
    The network endpoints available for this DB System.
    faultDomain String
    The name of the Fault Domain the DB System is located in.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostnameLabel String
    The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
    id String
    OCID of the backup itself
    ipAddress String
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    isHighlyAvailable Boolean
    Specifies if the DB System is highly available.
    maintenances List<Property Map>
    The Maintenance Policy for the DB System or Read Replica that this model is included in.
    mysqlVersion String
    The MySQL server version of the DB System used for backup.
    port Number
    The port for primary endpoint of the DB System to listen on.
    portX Number
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    readEndpoints List<Property Map>
    The read endpoint of a DB System.
    region String
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    secureConnections List<Property Map>
    Secure connection configuration details.
    shapeName String
    The shape of the DB System instance used for backup.
    subnetId String
    The OCID of the subnet the DB System is associated with.

    MysqlBackupDbSystemSnapshotBackupPolicy, MysqlBackupDbSystemSnapshotBackupPolicyArgs

    CopyPolicies List<MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy>
    List of policies of a DB system to schedule cross-region DB system backup copy.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    PitrPolicies List<MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy>
    The PITR policy for the DB System.
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    WindowStartTime string
    The start time of the maintenance window.
    CopyPolicies []MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy
    List of policies of a DB system to schedule cross-region DB system backup copy.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    PitrPolicies []MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy
    The PITR policy for the DB System.
    RetentionInDays int
    (Updatable) Number of days to retain this backup.
    WindowStartTime string
    The start time of the maintenance window.
    copyPolicies List<BackupDbSystemSnapshotBackupPolicyCopyPolicy>
    List of policies of a DB system to schedule cross-region DB system backup copy.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.
    pitrPolicies List<BackupDbSystemSnapshotBackupPolicyPitrPolicy>
    The PITR policy for the DB System.
    retentionInDays Integer
    (Updatable) Number of days to retain this backup.
    windowStartTime String
    The start time of the maintenance window.
    copyPolicies MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy[]
    List of policies of a DB system to schedule cross-region DB system backup copy.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled boolean
    Specifies if the DB System read endpoint is enabled or not.
    pitrPolicies MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy[]
    The PITR policy for the DB System.
    retentionInDays number
    (Updatable) Number of days to retain this backup.
    windowStartTime string
    The start time of the maintenance window.
    copy_policies Sequence[MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy]
    List of policies of a DB system to schedule cross-region DB system backup copy.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    is_enabled bool
    Specifies if the DB System read endpoint is enabled or not.
    pitr_policies Sequence[MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy]
    The PITR policy for the DB System.
    retention_in_days int
    (Updatable) Number of days to retain this backup.
    window_start_time str
    The start time of the maintenance window.
    copyPolicies List<Property Map>
    List of policies of a DB system to schedule cross-region DB system backup copy.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.
    pitrPolicies List<Property Map>
    The PITR policy for the DB System.
    retentionInDays Number
    (Updatable) Number of days to retain this backup.
    windowStartTime String
    The start time of the maintenance window.

    MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy, MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicyArgs

    BackupCopyRetentionInDays int
    Number of days to retain the copied DB system backup.
    CopyToRegion string
    The destination region name to which the DB system backup will be copied.
    BackupCopyRetentionInDays int
    Number of days to retain the copied DB system backup.
    CopyToRegion string
    The destination region name to which the DB system backup will be copied.
    backupCopyRetentionInDays Integer
    Number of days to retain the copied DB system backup.
    copyToRegion String
    The destination region name to which the DB system backup will be copied.
    backupCopyRetentionInDays number
    Number of days to retain the copied DB system backup.
    copyToRegion string
    The destination region name to which the DB system backup will be copied.
    backup_copy_retention_in_days int
    Number of days to retain the copied DB system backup.
    copy_to_region str
    The destination region name to which the DB system backup will be copied.
    backupCopyRetentionInDays Number
    Number of days to retain the copied DB system backup.
    copyToRegion String
    The destination region name to which the DB system backup will be copied.

    MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy, MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicyArgs

    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.
    isEnabled boolean
    Specifies if the DB System read endpoint is enabled or not.
    is_enabled bool
    Specifies if the DB System read endpoint is enabled or not.
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.

    MysqlBackupDbSystemSnapshotDataStorage, MysqlBackupDbSystemSnapshotDataStorageArgs

    AllocatedStorageSizeInGbs int
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DataStorageSizeLimitInGbs int
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    IsAutoExpandStorageEnabled bool
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    MaxStorageSizeInGbs int
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.
    AllocatedStorageSizeInGbs int
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    DataStorageSizeInGb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    DataStorageSizeLimitInGbs int
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    IsAutoExpandStorageEnabled bool
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    MaxStorageSizeInGbs int
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.
    allocatedStorageSizeInGbs Integer
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    dataStorageSizeInGb Integer
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorageSizeLimitInGbs Integer
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    isAutoExpandStorageEnabled Boolean
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    maxStorageSizeInGbs Integer
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.
    allocatedStorageSizeInGbs number
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    dataStorageSizeInGb number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorageSizeLimitInGbs number
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    isAutoExpandStorageEnabled boolean
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    maxStorageSizeInGbs number
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.
    allocated_storage_size_in_gbs int
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    data_storage_size_in_gb int
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    data_storage_size_limit_in_gbs int
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    is_auto_expand_storage_enabled bool
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    max_storage_size_in_gbs int
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.
    allocatedStorageSizeInGbs Number
    The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
    dataStorageSizeInGb Number
    DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
    dataStorageSizeLimitInGbs Number
    The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value.
    isAutoExpandStorageEnabled Boolean
    Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
    maxStorageSizeInGbs Number
    Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value.

    MysqlBackupDbSystemSnapshotDeletionPolicy, MysqlBackupDbSystemSnapshotDeletionPolicyArgs

    AutomaticBackupRetention string
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    FinalBackup string
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    IsDeleteProtected bool
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
    AutomaticBackupRetention string
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    FinalBackup string
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    IsDeleteProtected bool
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
    automaticBackupRetention String
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    finalBackup String
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    isDeleteProtected Boolean
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
    automaticBackupRetention string
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    finalBackup string
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    isDeleteProtected boolean
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
    automatic_backup_retention str
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    final_backup str
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    is_delete_protected bool
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
    automaticBackupRetention String
    Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
    finalBackup String
    Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
    isDeleteProtected Boolean
    Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

    MysqlBackupDbSystemSnapshotEndpoint, MysqlBackupDbSystemSnapshotEndpointArgs

    Hostname string
    The network address of the DB System.
    IpAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    Modes List<string>
    The access modes from the client that this endpoint supports.
    Port int
    The port for primary endpoint of the DB System to listen on.
    PortX int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    ResourceId string
    The OCID of the resource that this endpoint is attached to.
    ResourceType string
    The type of endpoint that clients and connectors can connect to.
    Status string
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    StatusDetails string
    Additional information about the current endpoint status.
    Hostname string
    The network address of the DB System.
    IpAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    Modes []string
    The access modes from the client that this endpoint supports.
    Port int
    The port for primary endpoint of the DB System to listen on.
    PortX int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    ResourceId string
    The OCID of the resource that this endpoint is attached to.
    ResourceType string
    The type of endpoint that clients and connectors can connect to.
    Status string
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    StatusDetails string
    Additional information about the current endpoint status.
    hostname String
    The network address of the DB System.
    ipAddress String
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    modes List<String>
    The access modes from the client that this endpoint supports.
    port Integer
    The port for primary endpoint of the DB System to listen on.
    portX Integer
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    resourceId String
    The OCID of the resource that this endpoint is attached to.
    resourceType String
    The type of endpoint that clients and connectors can connect to.
    status String
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    statusDetails String
    Additional information about the current endpoint status.
    hostname string
    The network address of the DB System.
    ipAddress string
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    modes string[]
    The access modes from the client that this endpoint supports.
    port number
    The port for primary endpoint of the DB System to listen on.
    portX number
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    resourceId string
    The OCID of the resource that this endpoint is attached to.
    resourceType string
    The type of endpoint that clients and connectors can connect to.
    status string
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    statusDetails string
    Additional information about the current endpoint status.
    hostname str
    The network address of the DB System.
    ip_address str
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    modes Sequence[str]
    The access modes from the client that this endpoint supports.
    port int
    The port for primary endpoint of the DB System to listen on.
    port_x int
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    resource_id str
    The OCID of the resource that this endpoint is attached to.
    resource_type str
    The type of endpoint that clients and connectors can connect to.
    status str
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    status_details str
    Additional information about the current endpoint status.
    hostname String
    The network address of the DB System.
    ipAddress String
    The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
    modes List<String>
    The access modes from the client that this endpoint supports.
    port Number
    The port for primary endpoint of the DB System to listen on.
    portX Number
    The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
    resourceId String
    The OCID of the resource that this endpoint is attached to.
    resourceType String
    The type of endpoint that clients and connectors can connect to.
    status String
    The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
    statusDetails String
    Additional information about the current endpoint status.

    MysqlBackupDbSystemSnapshotMaintenance, MysqlBackupDbSystemSnapshotMaintenanceArgs

    WindowStartTime string
    The start time of the maintenance window.
    WindowStartTime string
    The start time of the maintenance window.
    windowStartTime String
    The start time of the maintenance window.
    windowStartTime string
    The start time of the maintenance window.
    window_start_time str
    The start time of the maintenance window.
    windowStartTime String
    The start time of the maintenance window.

    MysqlBackupDbSystemSnapshotReadEndpoint, MysqlBackupDbSystemSnapshotReadEndpointArgs

    ExcludeIps List<string>
    A list of IP addresses of read replicas that are excluded from serving read requests.
    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    ReadEndpointHostnameLabel string
    The hostname for the read endpoint of the DB System. Used for DNS.
    ReadEndpointIpAddress string
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.
    ExcludeIps []string
    A list of IP addresses of read replicas that are excluded from serving read requests.
    IsEnabled bool
    Specifies if the DB System read endpoint is enabled or not.
    ReadEndpointHostnameLabel string
    The hostname for the read endpoint of the DB System. Used for DNS.
    ReadEndpointIpAddress string
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.
    excludeIps List<String>
    A list of IP addresses of read replicas that are excluded from serving read requests.
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.
    readEndpointHostnameLabel String
    The hostname for the read endpoint of the DB System. Used for DNS.
    readEndpointIpAddress String
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.
    excludeIps string[]
    A list of IP addresses of read replicas that are excluded from serving read requests.
    isEnabled boolean
    Specifies if the DB System read endpoint is enabled or not.
    readEndpointHostnameLabel string
    The hostname for the read endpoint of the DB System. Used for DNS.
    readEndpointIpAddress string
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.
    exclude_ips Sequence[str]
    A list of IP addresses of read replicas that are excluded from serving read requests.
    is_enabled bool
    Specifies if the DB System read endpoint is enabled or not.
    read_endpoint_hostname_label str
    The hostname for the read endpoint of the DB System. Used for DNS.
    read_endpoint_ip_address str
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.
    excludeIps List<String>
    A list of IP addresses of read replicas that are excluded from serving read requests.
    isEnabled Boolean
    Specifies if the DB System read endpoint is enabled or not.
    readEndpointHostnameLabel String
    The hostname for the read endpoint of the DB System. Used for DNS.
    readEndpointIpAddress String
    The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.

    MysqlBackupDbSystemSnapshotSecureConnection, MysqlBackupDbSystemSnapshotSecureConnectionArgs

    CertificateGenerationType string
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    CertificateId string
    The OCID of the certificate to use.
    CertificateGenerationType string
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    CertificateId string
    The OCID of the certificate to use.
    certificateGenerationType String
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    certificateId String
    The OCID of the certificate to use.
    certificateGenerationType string
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    certificateId string
    The OCID of the certificate to use.
    certificate_generation_type str
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    certificate_id str
    The OCID of the certificate to use.
    certificateGenerationType String
    Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
    certificateId String
    The OCID of the certificate to use.

    MysqlBackupDbSystemSnapshotSummary, MysqlBackupDbSystemSnapshotSummaryArgs

    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    Id string
    OCID of the backup itself
    Region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    DisplayName string
    (Updatable) A user-supplied display name for the backup.
    Id string
    OCID of the backup itself
    Region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    id String
    OCID of the backup itself
    region String
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    displayName string
    (Updatable) A user-supplied display name for the backup.
    id string
    OCID of the backup itself
    region string
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    display_name str
    (Updatable) A user-supplied display name for the backup.
    id str
    OCID of the backup itself
    region str
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
    displayName String
    (Updatable) A user-supplied display name for the backup.
    id String
    OCID of the backup itself
    region String
    The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.

    MysqlBackupSourceDetails, MysqlBackupSourceDetailsArgs

    BackupId string
    The OCID of the source backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    Region string
    The region of the backup source.
    BackupId string
    The OCID of the source backup.
    CompartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    Region string
    The region of the backup source.
    backupId String
    The OCID of the source backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    region String
    The region of the backup source.
    backupId string
    The OCID of the source backup.
    compartmentId string
    (Updatable) The OCID of the compartment the backup exists in.
    region string
    The region of the backup source.
    backup_id str
    The OCID of the source backup.
    compartment_id str
    (Updatable) The OCID of the compartment the backup exists in.
    region str
    The region of the backup source.
    backupId String
    The OCID of the source backup.
    compartmentId String
    (Updatable) The OCID of the compartment the backup exists in.
    region String
    The region of the backup source.

    Import

    MysqlBackups can be imported using the id, e.g.

    $ pulumi import oci:Mysql/mysqlBackup:MysqlBackup test_mysql_backup "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci