Oracle Cloud Infrastructure v1.41.0, Jun 19 24

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.Mysql.getMysqlBackup

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

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/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 GetMysqlBackup(ctx *Context, args *GetMysqlBackupArgs, opts ...InvokeOption) (*GetMysqlBackupResult, error)
func GetMysqlBackupOutput(ctx *Context, args *GetMysqlBackupOutputArgs, opts ...InvokeOption) GetMysqlBackupResultOutput

> Note: This function is named GetMysqlBackup 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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Mysql/getMysqlBackup:getMysqlBackup
  arguments:
    # arguments dictionary

The 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
BackupSizeInGbs int: 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.
DataStorageSizeInGb int: Initial size of the data volume in GiBs that will be created and attached.
DbSystemId string: The OCID of the DB System the backup is associated with.
DbSystemSnapshots List<GetMysqlBackupDbSystemSnapshot>: Snapshot of the DbSystem details at the time of the backup
DefinedTags Dictionary<string, object>: 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.
FreeformTags Dictionary<string, object>: 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
LifecycleDetails string: Additional information about the current lifecycleState.
MysqlVersion string: The MySQL server version of the DB System used for backup.
RetentionInDays int: Number of days to retain this backup.
ShapeName string: The shape of the DB System instance used for backup.
State string: The state of the backup.
TimeCreated string: The time the backup record was created.
TimeUpdated string: The time at which the backup was updated.

BackupId string
BackupSizeInGbs int: 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.
DataStorageSizeInGb int: Initial size of the data volume in GiBs that will be created and attached.
DbSystemId string: The OCID of the DB System the backup is associated with.
DbSystemSnapshots []GetMysqlBackupDbSystemSnapshot: Snapshot of the DbSystem details at the time of the backup
DefinedTags map[string]interface{}: 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.
FreeformTags map[string]interface{}: 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
LifecycleDetails string: Additional information about the current lifecycleState.
MysqlVersion string: The MySQL server version of the DB System used for backup.
RetentionInDays int: Number of days to retain this backup.
ShapeName string: The shape of the DB System instance used for backup.
State string: The state of the backup.
TimeCreated string: The time the backup record was created.
TimeUpdated string: The time at which the backup was updated.

backupId String
backupSizeInGbs Integer: 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.
dataStorageSizeInGb Integer: Initial size of the data volume in GiBs that will be created and attached.
dbSystemId String: The OCID of the DB System the backup is associated with.
dbSystemSnapshots List<GetBackupDbSystemSnapshot>: Snapshot of the DbSystem details at the time of the backup
definedTags Map<String,Object>: 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.
freeformTags Map<String,Object>: 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
lifecycleDetails String: Additional information about the current lifecycleState.
mysqlVersion String: The MySQL server version of the DB System used for backup.
retentionInDays Integer: Number of days to retain this backup.
shapeName String: The shape of the DB System instance used for backup.
state String: The state of the backup.
timeCreated String: The time the backup record was created.
timeUpdated String: The time at which the backup was updated.

backupId string
backupSizeInGbs number: 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.
dataStorageSizeInGb number: Initial size of the data volume in GiBs that will be created and attached.
dbSystemId string: The OCID of the DB System the backup is associated with.
dbSystemSnapshots GetMysqlBackupDbSystemSnapshot[]: Snapshot of the DbSystem details at the time of the backup
definedTags {[key: string]: any}: 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.
freeformTags {[key: string]: any}: 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
lifecycleDetails string: Additional information about the current lifecycleState.
mysqlVersion string: The MySQL server version of the DB System used for backup.
retentionInDays number: Number of days to retain this backup.
shapeName string: The shape of the DB System instance used for backup.
state string: The state of the backup.
timeCreated string: The time the backup record was created.
timeUpdated string: The time at which the backup was updated.

backup_id str
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: 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_size_in_gb int: Initial size of the data volume in GiBs that will be created and attached.
db_system_id str: The OCID of the DB System the backup is associated with.
db_system_snapshots Sequence[mysql.GetMysqlBackupDbSystemSnapshot]: Snapshot of the DbSystem details at the time of the backup
defined_tags Mapping[str, Any]: 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.
freeform_tags Mapping[str, Any]: 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
lifecycle_details str: Additional information about the current lifecycleState.
mysql_version str: The MySQL server version of the DB System used for backup.
retention_in_days int: Number of days to retain this backup.
shape_name str: The shape of the DB System instance used for backup.
state str: The state of the backup.
time_created str: The time the backup record was created.
time_updated str: The time at which the backup was updated.

backupId String
backupSizeInGbs Number: 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.
dataStorageSizeInGb Number: Initial size of the data volume in GiBs that will be created and attached.
dbSystemId String: The OCID of the DB System the backup is associated with.
dbSystemSnapshots List<Property Map>: Snapshot of the DbSystem details at the time of the backup
definedTags Map<Any>: 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.
freeformTags Map<Any>: 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
lifecycleDetails String: Additional information about the current lifecycleState.
mysqlVersion String: The MySQL server version of the DB System used for backup.
retentionInDays Number: Number of days to retain this backup.
shapeName String: The shape of the DB System instance used for backup.
state String: The state of the backup.
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<GetMysqlBackupDbSystemSnapshotBackupPolicy>: 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.
DataStorageSizeInGb int: Initial size of the data volume in GiBs that will be created and attached.
DatabaseManagement string: Whether to enable monitoring via the Database Management service.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeletionPolicies List<GetMysqlBackupDbSystemSnapshotDeletionPolicy>: 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<GetMysqlBackupDbSystemSnapshotEndpoint>: 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, object>: 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<GetMysqlBackupDbSystemSnapshotMaintenance>: 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.
SecureConnections List<GetMysqlBackupDbSystemSnapshotSecureConnection>: 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 []GetMysqlBackupDbSystemSnapshotBackupPolicy: 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.
DataStorageSizeInGb int: Initial size of the data volume in GiBs that will be created and attached.
DatabaseManagement string: Whether to enable monitoring via the Database Management service.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeletionPolicies []GetMysqlBackupDbSystemSnapshotDeletionPolicy: 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 []GetMysqlBackupDbSystemSnapshotEndpoint: 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]interface{}: 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 []GetMysqlBackupDbSystemSnapshotMaintenance: 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.
SecureConnections []GetMysqlBackupDbSystemSnapshotSecureConnection: 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<GetBackupDbSystemSnapshotBackupPolicy>: 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.
dataStorageSizeInGb Integer: Initial size of the data volume in GiBs that will be created and attached.
databaseManagement String: Whether to enable monitoring via the Database Management service.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deletionPolicies List<GetBackupDbSystemSnapshotDeletionPolicy>: 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<GetBackupDbSystemSnapshotEndpoint>: 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,Object>: 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<GetBackupDbSystemSnapshotMaintenance>: 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.
secureConnections List<GetBackupDbSystemSnapshotSecureConnection>: 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 GetMysqlBackupDbSystemSnapshotBackupPolicy[]: 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.
dataStorageSizeInGb number: Initial size of the data volume in GiBs that will be created and attached.
databaseManagement string: Whether to enable monitoring via the Database Management service.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deletionPolicies GetMysqlBackupDbSystemSnapshotDeletionPolicy[]: 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 GetMysqlBackupDbSystemSnapshotEndpoint[]: 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]: any}: 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 GetMysqlBackupDbSystemSnapshotMaintenance[]: 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.
secureConnections GetMysqlBackupDbSystemSnapshotSecureConnection[]: 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[mysql.GetMysqlBackupDbSystemSnapshotBackupPolicy]: 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_size_in_gb int: Initial size of the data volume in GiBs that will be created and attached.
database_management str: Whether to enable monitoring via the Database Management service.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deletion_policies Sequence[mysql.GetMysqlBackupDbSystemSnapshotDeletionPolicy]: 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[mysql.GetMysqlBackupDbSystemSnapshotEndpoint]: 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, Any]: 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[mysql.GetMysqlBackupDbSystemSnapshotMaintenance]: 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.
secure_connections Sequence[mysql.GetMysqlBackupDbSystemSnapshotSecureConnection]: 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.
dataStorageSizeInGb Number: Initial size of the data volume in GiBs that will be created and attached.
databaseManagement String: Whether to enable monitoring via the Database Management service.
definedTags Map<Any>: 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.
freeformTags Map<Any>: 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.
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

DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags Dictionary<string, object>: 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 PITR is enabled or disabled.
PitrPolicies List<GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy>: The PITR policy for the DB System.
RetentionInDays int: Number of days to retain this backup.
WindowStartTime string: The start time of the maintenance window.

DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
FreeformTags map[string]interface{}: 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 PITR is enabled or disabled.
PitrPolicies []GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy: The PITR policy for the DB System.
RetentionInDays int: Number of days to retain this backup.
WindowStartTime string: The start time of the maintenance window.

definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<String,Object>: 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 PITR is enabled or disabled.
pitrPolicies List<GetBackupDbSystemSnapshotBackupPolicyPitrPolicy>: The PITR policy for the DB System.
retentionInDays Integer: Number of days to retain this backup.
windowStartTime String: The start time of the maintenance window.

definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags {[key: string]: any}: 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 PITR is enabled or disabled.
pitrPolicies GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy[]: The PITR policy for the DB System.
retentionInDays number: Number of days to retain this backup.
windowStartTime string: The start time of the maintenance window.

defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeform_tags Mapping[str, Any]: 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 PITR is enabled or disabled.
pitr_policies Sequence[mysql.GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy]: The PITR policy for the DB System.
retention_in_days int: Number of days to retain this backup.
window_start_time str: The start time of the maintenance window.

definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
freeformTags Map<Any>: 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 PITR is enabled or disabled.
pitrPolicies List<Property Map>: The PITR policy for the DB System.
retentionInDays Number: Number of days to retain this backup.
windowStartTime String: The start time of the maintenance window.

GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy

IsEnabled bool: Specifies if PITR is enabled or disabled.

IsEnabled bool: Specifies if PITR is enabled or disabled.

isEnabled Boolean: Specifies if PITR is enabled or disabled.

isEnabled boolean: Specifies if PITR is enabled or disabled.

is_enabled bool: Specifies if PITR is enabled or disabled.

isEnabled Boolean: Specifies if PITR is enabled or disabled.

GetMysqlBackupDbSystemSnapshotDeletionPolicy

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.

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

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.

GetMysqlBackupDbSystemSnapshotSecureConnection

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.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.Mysql.getMysqlBackup

On this page

On this page

Example Usage

Using getMysqlBackup

getMysqlBackup Result

Supporting Types

GetMysqlBackupDbSystemSnapshot

GetMysqlBackupDbSystemSnapshotBackupPolicy

GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy

GetMysqlBackupDbSystemSnapshotDeletionPolicy

GetMysqlBackupDbSystemSnapshotEndpoint

GetMysqlBackupDbSystemSnapshotMaintenance

GetMysqlBackupDbSystemSnapshotSecureConnection

Package Details

On this page

On this page