Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.Mysql.getMysqlBackup
Explore with Pulumi AI
This data source provides details about a specific Mysql Backup resource in Oracle Cloud Infrastructure MySQL Database service.
Get information about the specified Backup
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMysqlBackup = oci.Mysql.getMysqlBackup({
    backupId: testBackup.id,
});
import pulumi
import pulumi_oci as oci
test_mysql_backup = oci.Mysql.get_mysql_backup(backup_id=test_backup["id"])
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.GetMysqlBackup(ctx, &mysql.GetMysqlBackupArgs{
			BackupId: testBackup.Id,
		}, nil)
		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 = Oci.Mysql.GetMysqlBackup.Invoke(new()
    {
        BackupId = testBackup.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Mysql.MysqlFunctions;
import com.pulumi.oci.Mysql.inputs.GetMysqlBackupArgs;
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) {
        final var testMysqlBackup = MysqlFunctions.getMysqlBackup(GetMysqlBackupArgs.builder()
            .backupId(testBackup.id())
            .build());
    }
}
variables:
  testMysqlBackup:
    fn::invoke:
      function: oci:Mysql:getMysqlBackup
      arguments:
        backupId: ${testBackup.id}
Using getMysqlBackup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getMysqlBackup(args: GetMysqlBackupArgs, opts?: InvokeOptions): Promise<GetMysqlBackupResult>
function getMysqlBackupOutput(args: GetMysqlBackupOutputArgs, opts?: InvokeOptions): Output<GetMysqlBackupResult>def get_mysql_backup(backup_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetMysqlBackupResult
def get_mysql_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetMysqlBackupResult]func LookupMysqlBackup(ctx *Context, args *LookupMysqlBackupArgs, opts ...InvokeOption) (*LookupMysqlBackupResult, error)
func LookupMysqlBackupOutput(ctx *Context, args *LookupMysqlBackupOutputArgs, opts ...InvokeOption) LookupMysqlBackupResultOutput> Note: This function is named LookupMysqlBackup in the Go SDK.
public static class GetMysqlBackup 
{
    public static Task<GetMysqlBackupResult> InvokeAsync(GetMysqlBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetMysqlBackupResult> Invoke(GetMysqlBackupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetMysqlBackupResult> getMysqlBackup(GetMysqlBackupArgs args, InvokeOptions options)
public static Output<GetMysqlBackupResult> getMysqlBackup(GetMysqlBackupArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Mysql/getMysqlBackup:getMysqlBackup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- BackupId string
- The OCID of the Backup
- BackupId string
- The OCID of the Backup
- backupId String
- The OCID of the Backup
- backupId string
- The OCID of the Backup
- backup_id str
- The OCID of the Backup
- backupId String
- The OCID of the Backup
getMysqlBackup Result
The following output properties are available:
- BackupId string
- BackupSize intIn Gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- BackupType string
- The type of backup.
- CompartmentId string
- The OCID of the compartment the DB System belongs in.
- CreationType string
- Indicates how the backup was created: manually, automatic, or by an Operator.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DbSystem stringId 
- The OCID of the DB System the backup is associated with.
- DbSystem List<GetSnapshot Summaries Mysql Backup Db System Snapshot Summary> 
- DbSystem List<GetSnapshots Mysql Backup Db System Snapshot> 
- Snapshot of the DbSystem details at the time of the backup
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- A user-supplied description for the backup.
- DisplayName string
- A user-supplied display name for the backup.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- OCID of the backup itself
- ImmediateSource stringBackup Id 
- 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.
- OriginalSource stringBackup Id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- RetentionIn intDays 
- Number of days to retain this backup.
- ShapeName string
- The shape of the DB System instance used for backup.
- SourceDetails List<GetMysql Backup Source Detail> 
- State string
- The state of the backup.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCopy stringCreated 
- 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.
- BackupId string
- BackupSize intIn Gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- BackupType string
- The type of backup.
- CompartmentId string
- The OCID of the compartment the DB System belongs in.
- CreationType string
- Indicates how the backup was created: manually, automatic, or by an Operator.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DbSystem stringId 
- The OCID of the DB System the backup is associated with.
- DbSystem []GetSnapshot Summaries Mysql Backup Db System Snapshot Summary 
- DbSystem []GetSnapshots Mysql Backup Db System Snapshot 
- Snapshot of the DbSystem details at the time of the backup
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- A user-supplied description for the backup.
- DisplayName string
- A user-supplied display name for the backup.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- OCID of the backup itself
- ImmediateSource stringBackup Id 
- 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.
- OriginalSource stringBackup Id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- RetentionIn intDays 
- Number of days to retain this backup.
- ShapeName string
- The shape of the DB System instance used for backup.
- SourceDetails []GetMysql Backup Source Detail 
- State string
- The state of the backup.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCopy stringCreated 
- 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.
- backupId String
- backupSize IntegerIn Gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- backupType String
- The type of backup.
- compartmentId String
- The OCID of the compartment the DB System belongs in.
- creationType String
- Indicates how the backup was created: manually, automatic, or by an Operator.
- dataStorage IntegerSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dbSystem StringId 
- The OCID of the DB System the backup is associated with.
- dbSystem List<GetSnapshot Summaries Backup Db System Snapshot Summary> 
- dbSystem List<GetSnapshots Backup Db System Snapshot> 
- Snapshot of the DbSystem details at the time of the backup
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- A user-supplied description for the backup.
- displayName String
- A user-supplied display name for the backup.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- OCID of the backup itself
- immediateSource StringBackup Id 
- 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.
- originalSource StringBackup Id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- retentionIn IntegerDays 
- Number of days to retain this backup.
- shapeName String
- The shape of the DB System instance used for backup.
- sourceDetails List<GetBackup Source Detail> 
- state String
- The state of the backup.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCopy StringCreated 
- 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.
- backupId string
- backupSize numberIn Gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- backupType string
- The type of backup.
- compartmentId string
- The OCID of the compartment the DB System belongs in.
- creationType string
- Indicates how the backup was created: manually, automatic, or by an Operator.
- dataStorage numberSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dbSystem stringId 
- The OCID of the DB System the backup is associated with.
- dbSystem GetSnapshot Summaries Mysql Backup Db System Snapshot Summary[] 
- dbSystem GetSnapshots Mysql Backup Db System Snapshot[] 
- Snapshot of the DbSystem details at the time of the backup
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- A user-supplied description for the backup.
- displayName string
- A user-supplied display name for the backup.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id string
- OCID of the backup itself
- immediateSource stringBackup Id 
- 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.
- originalSource stringBackup Id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- retentionIn numberDays 
- Number of days to retain this backup.
- shapeName string
- The shape of the DB System instance used for backup.
- sourceDetails GetMysql Backup Source Detail[] 
- state string
- The state of the backup.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCopy stringCreated 
- 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_id str
- backup_size_ intin_ gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- backup_type str
- The type of backup.
- compartment_id str
- The OCID of the compartment the DB System belongs in.
- creation_type str
- Indicates how the backup was created: manually, automatic, or by an Operator.
- data_storage_ intsize_ in_ gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- db_system_ strid 
- The OCID of the DB System the backup is associated with.
- db_system_ Sequence[Getsnapshot_ summaries Mysql Backup Db System Snapshot Summary] 
- db_system_ Sequence[Getsnapshots Mysql Backup Db System Snapshot] 
- Snapshot of the DbSystem details at the time of the backup
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- A user-supplied description for the backup.
- display_name str
- A user-supplied display name for the backup.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id str
- OCID of the backup itself
- immediate_source_ strbackup_ id 
- 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_ strbackup_ id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- retention_in_ intdays 
- Number of days to retain this backup.
- shape_name str
- The shape of the DB System instance used for backup.
- source_details Sequence[GetMysql Backup Source Detail] 
- state str
- The state of the backup.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_copy_ strcreated 
- 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.
- backupId String
- backupSize NumberIn Gbs 
- The size of the backup in base-2 (IEC) gibibytes. (GiB).
- backupType String
- The type of backup.
- compartmentId String
- The OCID of the compartment the DB System belongs in.
- creationType String
- Indicates how the backup was created: manually, automatic, or by an Operator.
- dataStorage NumberSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dbSystem StringId 
- The OCID of the DB System the backup is associated with.
- dbSystem List<Property Map>Snapshot Summaries 
- dbSystem List<Property Map>Snapshots 
- Snapshot of the DbSystem details at the time of the backup
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- A user-supplied description for the backup.
- displayName String
- A user-supplied display name for the backup.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- OCID of the backup itself
- immediateSource StringBackup Id 
- 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.
- originalSource StringBackup Id 
- The OCID of the original source DB system backup from which this DB system backup was copied.
- retentionIn NumberDays 
- Number of days to retain this backup.
- shapeName String
- The shape of the DB System instance used for backup.
- sourceDetails List<Property Map>
- state String
- The state of the backup.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCopy StringCreated 
- 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
GetMysqlBackupDbSystemSnapshot     
- AdminUsername string
- The username for the administrative user.
- AvailabilityDomain string
- The Availability Domain where the primary DB System should be located.
- BackupPolicies List<GetMysql Backup Db System Snapshot Backup Policy> 
- The Backup policy for the DB System.
- CompartmentId string
- The OCID of the compartment the DB System belongs 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.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DataStorages List<GetMysql Backup Db System Snapshot Data Storage> 
- Data Storage information.
- DatabaseManagement string
- Whether to enable monitoring via the Database Management service.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeletionPolicies List<GetMysql Backup Db System Snapshot Deletion Policy> 
- The Deletion policy for the DB System.
- Description string
- A user-supplied description for the backup.
- DisplayName string
- A user-supplied display name for the backup.
- Endpoints
List<GetMysql Backup Db System Snapshot Endpoint> 
- The network endpoints available for this DB System.
- FaultDomain string
- The name of the Fault Domain the DB System is located in.
- Dictionary<string, string>
- 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.
- IsHighly boolAvailable 
- Specifies if the DB System is highly available.
- Maintenances
List<GetMysql Backup Db System Snapshot Maintenance> 
- 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<GetMysql Backup Db System Snapshot Read Endpoint> 
- 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<GetMysql Backup Db System Snapshot Secure Connection> 
- 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 []GetMysql Backup Db System Snapshot Backup Policy 
- The Backup policy for the DB System.
- CompartmentId string
- The OCID of the compartment the DB System belongs 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.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DataStorages []GetMysql Backup Db System Snapshot Data Storage 
- Data Storage information.
- DatabaseManagement string
- Whether to enable monitoring via the Database Management service.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeletionPolicies []GetMysql Backup Db System Snapshot Deletion Policy 
- The Deletion policy for the DB System.
- Description string
- A user-supplied description for the backup.
- DisplayName string
- A user-supplied display name for the backup.
- Endpoints
[]GetMysql Backup Db System Snapshot Endpoint 
- The network endpoints available for this DB System.
- FaultDomain string
- The name of the Fault Domain the DB System is located in.
- map[string]string
- 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.
- IsHighly boolAvailable 
- Specifies if the DB System is highly available.
- Maintenances
[]GetMysql Backup Db System Snapshot Maintenance 
- 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 []GetMysql Backup Db System Snapshot Read Endpoint 
- 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 []GetMysql Backup Db System Snapshot Secure Connection 
- 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<GetBackup Db System Snapshot Backup Policy> 
- The Backup policy for the DB System.
- compartmentId String
- The OCID of the compartment the DB System belongs 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.
- dataStorage IntegerSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dataStorages List<GetBackup Db System Snapshot Data Storage> 
- Data Storage information.
- databaseManagement String
- Whether to enable monitoring via the Database Management service.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deletionPolicies List<GetBackup Db System Snapshot Deletion Policy> 
- The Deletion policy for the DB System.
- description String
- A user-supplied description for the backup.
- displayName String
- A user-supplied display name for the backup.
- endpoints
List<GetBackup Db System Snapshot Endpoint> 
- The network endpoints available for this DB System.
- faultDomain String
- The name of the Fault Domain the DB System is located in.
- Map<String,String>
- 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.
- isHighly BooleanAvailable 
- Specifies if the DB System is highly available.
- maintenances
List<GetBackup Db System Snapshot Maintenance> 
- 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<GetBackup Db System Snapshot Read Endpoint> 
- 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<GetBackup Db System Snapshot Secure Connection> 
- 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 GetMysql Backup Db System Snapshot Backup Policy[] 
- The Backup policy for the DB System.
- compartmentId string
- The OCID of the compartment the DB System belongs 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.
- dataStorage numberSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dataStorages GetMysql Backup Db System Snapshot Data Storage[] 
- Data Storage information.
- databaseManagement string
- Whether to enable monitoring via the Database Management service.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deletionPolicies GetMysql Backup Db System Snapshot Deletion Policy[] 
- The Deletion policy for the DB System.
- description string
- A user-supplied description for the backup.
- displayName string
- A user-supplied display name for the backup.
- endpoints
GetMysql Backup Db System Snapshot Endpoint[] 
- The network endpoints available for this DB System.
- faultDomain string
- The name of the Fault Domain the DB System is located in.
- {[key: string]: string}
- 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.
- isHighly booleanAvailable 
- Specifies if the DB System is highly available.
- maintenances
GetMysql Backup Db System Snapshot Maintenance[] 
- 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 GetMysql Backup Db System Snapshot Read Endpoint[] 
- 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 GetMysql Backup Db System Snapshot Secure Connection[] 
- 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[GetMysql Backup Db System Snapshot Backup Policy] 
- The Backup policy for the DB System.
- compartment_id str
- The OCID of the compartment the DB System belongs 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_ intsize_ in_ gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- data_storages Sequence[GetMysql Backup Db System Snapshot Data Storage] 
- Data Storage information.
- database_management str
- Whether to enable monitoring via the Database Management service.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deletion_policies Sequence[GetMysql Backup Db System Snapshot Deletion Policy] 
- The Deletion policy for the DB System.
- description str
- A user-supplied description for the backup.
- display_name str
- A user-supplied display name for the backup.
- endpoints
Sequence[GetMysql Backup Db System Snapshot Endpoint] 
- The network endpoints available for this DB System.
- fault_domain str
- The name of the Fault Domain the DB System is located in.
- Mapping[str, str]
- 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_ boolavailable 
- Specifies if the DB System is highly available.
- maintenances
Sequence[GetMysql Backup Db System Snapshot Maintenance] 
- 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[GetMysql Backup Db System Snapshot Read Endpoint] 
- 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[GetMysql Backup Db System Snapshot Secure Connection] 
- 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
- The OCID of the compartment the DB System belongs 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.
- dataStorage NumberSize In Gb 
- 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.
- Map<String>
- 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
- A user-supplied description for the backup.
- displayName String
- 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.
- Map<String>
- 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.
- isHighly BooleanAvailable 
- 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.
GetMysqlBackupDbSystemSnapshotBackupPolicy       
- CopyPolicies List<GetMysql Backup Db System Snapshot Backup Policy Copy Policy> 
- List of policies of a DB system to schedule cross-region DB system backup copy.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Dictionary<string, string>
- 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<GetMysql Backup Db System Snapshot Backup Policy Pitr Policy> 
- The PITR policy for the DB System.
- RetentionIn intDays 
- Number of days to retain this backup.
- WindowStart stringTime 
- The start time of the maintenance window.
- CopyPolicies []GetMysql Backup Db System Snapshot Backup Policy Copy Policy 
- List of policies of a DB system to schedule cross-region DB system backup copy.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- map[string]string
- 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 []GetMysql Backup Db System Snapshot Backup Policy Pitr Policy 
- The PITR policy for the DB System.
- RetentionIn intDays 
- Number of days to retain this backup.
- WindowStart stringTime 
- The start time of the maintenance window.
- copyPolicies List<GetBackup Db System Snapshot Backup Policy Copy Policy> 
- List of policies of a DB system to schedule cross-region DB system backup copy.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Map<String,String>
- 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<GetBackup Db System Snapshot Backup Policy Pitr Policy> 
- The PITR policy for the DB System.
- retentionIn IntegerDays 
- Number of days to retain this backup.
- windowStart StringTime 
- The start time of the maintenance window.
- copyPolicies GetMysql Backup Db System Snapshot Backup Policy Copy Policy[] 
- List of policies of a DB system to schedule cross-region DB system backup copy.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- {[key: string]: string}
- 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 GetMysql Backup Db System Snapshot Backup Policy Pitr Policy[] 
- The PITR policy for the DB System.
- retentionIn numberDays 
- Number of days to retain this backup.
- windowStart stringTime 
- The start time of the maintenance window.
- copy_policies Sequence[GetMysql Backup Db System Snapshot Backup Policy Copy Policy] 
- List of policies of a DB system to schedule cross-region DB system backup copy.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Mapping[str, str]
- 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[GetMysql Backup Db System Snapshot Backup Policy Pitr Policy] 
- The PITR policy for the DB System.
- retention_in_ intdays 
- Number of days to retain this backup.
- window_start_ strtime 
- 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.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Map<String>
- 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.
- retentionIn NumberDays 
- Number of days to retain this backup.
- windowStart StringTime 
- The start time of the maintenance window.
GetMysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy         
- BackupCopy intRetention In Days 
- Number of days to retain the copied DB system backup.
- CopyTo stringRegion 
- The destination region name to which the DB system backup will be copied.
- BackupCopy intRetention In Days 
- Number of days to retain the copied DB system backup.
- CopyTo stringRegion 
- The destination region name to which the DB system backup will be copied.
- backupCopy IntegerRetention In Days 
- Number of days to retain the copied DB system backup.
- copyTo StringRegion 
- The destination region name to which the DB system backup will be copied.
- backupCopy numberRetention In Days 
- Number of days to retain the copied DB system backup.
- copyTo stringRegion 
- The destination region name to which the DB system backup will be copied.
- backup_copy_ intretention_ in_ days 
- Number of days to retain the copied DB system backup.
- copy_to_ strregion 
- The destination region name to which the DB system backup will be copied.
- backupCopy NumberRetention In Days 
- Number of days to retain the copied DB system backup.
- copyTo StringRegion 
- The destination region name to which the DB system backup will be copied.
GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy         
- 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.
GetMysqlBackupDbSystemSnapshotDataStorage       
- AllocatedStorage intSize In Gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DataStorage intSize Limit In Gbs 
- 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.
- IsAuto boolExpand Storage Enabled 
- Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
- MaxStorage intSize In Gbs 
- 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.
- AllocatedStorage intSize In Gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- DataStorage intSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- DataStorage intSize Limit In Gbs 
- 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.
- IsAuto boolExpand Storage Enabled 
- Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
- MaxStorage intSize In Gbs 
- 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.
- allocatedStorage IntegerSize In Gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- dataStorage IntegerSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dataStorage IntegerSize Limit In Gbs 
- 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.
- isAuto BooleanExpand Storage Enabled 
- Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
- maxStorage IntegerSize In Gbs 
- 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.
- allocatedStorage numberSize In Gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- dataStorage numberSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dataStorage numberSize Limit In Gbs 
- 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.
- isAuto booleanExpand Storage Enabled 
- Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
- maxStorage numberSize In Gbs 
- 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_ intsize_ in_ gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- data_storage_ intsize_ in_ gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- data_storage_ intsize_ limit_ in_ gbs 
- 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_ boolexpand_ storage_ enabled 
- 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_ intsize_ in_ gbs 
- 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.
- allocatedStorage NumberSize In Gbs 
- The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred.
- dataStorage NumberSize In Gb 
- DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.
- dataStorage NumberSize Limit In Gbs 
- 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.
- isAuto BooleanExpand Storage Enabled 
- Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs.
- maxStorage NumberSize In Gbs 
- 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.
GetMysqlBackupDbSystemSnapshotDeletionPolicy       
- AutomaticBackup stringRetention 
- 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.
- IsDelete boolProtected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
- AutomaticBackup stringRetention 
- 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.
- IsDelete boolProtected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
- automaticBackup StringRetention 
- 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.
- isDelete BooleanProtected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
- automaticBackup stringRetention 
- 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.
- isDelete booleanProtected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
- automatic_backup_ strretention 
- 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_ boolprotected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
- automaticBackup StringRetention 
- 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.
- isDelete BooleanProtected 
- Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
GetMysqlBackupDbSystemSnapshotEndpoint      
- 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.
GetMysqlBackupDbSystemSnapshotMaintenance      
- WindowStart stringTime 
- The start time of the maintenance window.
- WindowStart stringTime 
- The start time of the maintenance window.
- windowStart StringTime 
- The start time of the maintenance window.
- windowStart stringTime 
- The start time of the maintenance window.
- window_start_ strtime 
- The start time of the maintenance window.
- windowStart StringTime 
- The start time of the maintenance window.
GetMysqlBackupDbSystemSnapshotReadEndpoint       
- 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.
- ReadEndpoint stringHostname Label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- ReadEndpoint stringIp Address 
- 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.
- ReadEndpoint stringHostname Label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- ReadEndpoint stringIp Address 
- 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.
- readEndpoint StringHostname Label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- readEndpoint StringIp Address 
- 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.
- readEndpoint stringHostname Label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- readEndpoint stringIp Address 
- 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_ strhostname_ label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- read_endpoint_ strip_ address 
- 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.
- readEndpoint StringHostname Label 
- The hostname for the read endpoint of the DB System. Used for DNS.
- readEndpoint StringIp Address 
- 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.
GetMysqlBackupDbSystemSnapshotSecureConnection       
- CertificateGeneration stringType 
- Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
- CertificateId string
- The OCID of the certificate to use.
- CertificateGeneration stringType 
- Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
- CertificateId string
- The OCID of the certificate to use.
- certificateGeneration StringType 
- Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
- certificateId String
- The OCID of the certificate to use.
- certificateGeneration stringType 
- 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_ strtype 
- 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.
- certificateGeneration StringType 
- Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
- certificateId String
- The OCID of the certificate to use.
GetMysqlBackupDbSystemSnapshotSummary      
- DisplayName string
- 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
- 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
- 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
- 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
- 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
- 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.
GetMysqlBackupSourceDetail    
- BackupId string
- The OCID of the Backup
- CompartmentId string
- The OCID of the compartment the DB System belongs in.
- Region string
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
- BackupId string
- The OCID of the Backup
- CompartmentId string
- The OCID of the compartment the DB System belongs in.
- Region string
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
- backupId String
- The OCID of the Backup
- compartmentId String
- The OCID of the compartment the DB System belongs in.
- region String
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
- backupId string
- The OCID of the Backup
- compartmentId string
- The OCID of the compartment the DB System belongs in.
- region string
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
- backup_id str
- The OCID of the Backup
- compartment_id str
- The OCID of the compartment the DB System belongs in.
- region str
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
- backupId String
- The OCID of the Backup
- compartmentId String
- The OCID of the compartment the DB System belongs in.
- region String
- The region identifier of the region where the DB system exists. For more information, please see Regions and Availability Domains.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.