Docs Packages
  1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. DataGuardAssociation
oci logo
Oracle Cloud Infrastructure v0.19.0, May 26 23

oci.Database.DataGuardAssociation

Explore with Pulumi AI

This resource provides the Data Guard Association resource in Oracle Cloud Infrastructure Database service.

Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard.

All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDataGuardAssociation = new Oci.Database.DataGuardAssociation("testDataGuardAssociation", new()
    {
        CreationType = @var.Data_guard_association_creation_type,
        DatabaseAdminPassword = @var.Data_guard_association_database_admin_password,
        DatabaseId = oci_database_database.Test_database.Id,
        DeleteStandbyDbHomeOnDelete = @var.Data_guard_association_delete_standby_db_home_on_delete,
        ProtectionMode = @var.Data_guard_association_protection_mode,
        TransportType = @var.Data_guard_association_transport_type,
        AvailabilityDomain = @var.Data_guard_association_availability_domain,
        BackupNetworkNsgIds = @var.Data_guard_association_backup_network_nsg_ids,
        CpuCoreCount = @var.Data_guard_association_cpu_core_count,
        DatabaseDefinedTags = @var.Data_guard_association_database_defined_tags,
        DatabaseFreeformTags = @var.Data_guard_association_database_freeform_tags,
        DataCollectionOptions = new Oci.Database.Inputs.DataGuardAssociationDataCollectionOptionsArgs
        {
            IsDiagnosticsEventsEnabled = @var.Data_guard_association_data_collection_options_is_diagnostics_events_enabled,
            IsHealthMonitoringEnabled = @var.Data_guard_association_data_collection_options_is_health_monitoring_enabled,
            IsIncidentLogsEnabled = @var.Data_guard_association_data_collection_options_is_incident_logs_enabled,
        },
        DatabaseSoftwareImageId = oci_database_database_software_image.Test_database_software_image.Id,
        DbSystemDefinedTags = @var.Data_guard_association_db_system_defined_tags,
        DbSystemFreeformTags = @var.Data_guard_association_db_system_freeform_tags,
        DisplayName = @var.Data_guard_association_display_name,
        FaultDomains = @var.Data_guard_association_fault_domains,
        Hostname = @var.Data_guard_association_hostname,
        IsActiveDataGuardEnabled = @var.Data_guard_association_is_active_data_guard_enabled,
        LicenseModel = @var.Data_guard_association_license_model,
        NodeCount = @var.Data_guard_association_node_count,
        NsgIds = @var.Data_guard_association_nsg_ids,
        PeerDbHomeId = oci_database_db_home.Test_db_home.Id,
        PeerDbSystemId = oci_database_db_system.Test_db_system.Id,
        PeerDbUniqueName = @var.Data_guard_association_peer_db_unique_name,
        PeerSidPrefix = @var.Data_guard_association_peer_sid_prefix,
        PeerVmClusterId = oci_database_vm_cluster.Test_vm_cluster.Id,
        PrivateIp = @var.Data_guard_association_private_ip,
        Shape = @var.Data_guard_association_shape,
        StorageVolumePerformanceMode = @var.Data_guard_association_storage_volume_performance_mode,
        SubnetId = oci_core_subnet.Test_subnet.Id,
        TimeZone = @var.Data_guard_association_time_zone,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.NewDataGuardAssociation(ctx, "testDataGuardAssociation", &Database.DataGuardAssociationArgs{
			CreationType:                pulumi.Any(_var.Data_guard_association_creation_type),
			DatabaseAdminPassword:       pulumi.Any(_var.Data_guard_association_database_admin_password),
			DatabaseId:                  pulumi.Any(oci_database_database.Test_database.Id),
			DeleteStandbyDbHomeOnDelete: pulumi.Any(_var.Data_guard_association_delete_standby_db_home_on_delete),
			ProtectionMode:              pulumi.Any(_var.Data_guard_association_protection_mode),
			TransportType:               pulumi.Any(_var.Data_guard_association_transport_type),
			AvailabilityDomain:          pulumi.Any(_var.Data_guard_association_availability_domain),
			BackupNetworkNsgIds:         pulumi.Any(_var.Data_guard_association_backup_network_nsg_ids),
			CpuCoreCount:                pulumi.Any(_var.Data_guard_association_cpu_core_count),
			DatabaseDefinedTags:         pulumi.Any(_var.Data_guard_association_database_defined_tags),
			DatabaseFreeformTags:        pulumi.Any(_var.Data_guard_association_database_freeform_tags),
			DataCollectionOptions: &database.DataGuardAssociationDataCollectionOptionsArgs{
				IsDiagnosticsEventsEnabled: pulumi.Any(_var.Data_guard_association_data_collection_options_is_diagnostics_events_enabled),
				IsHealthMonitoringEnabled:  pulumi.Any(_var.Data_guard_association_data_collection_options_is_health_monitoring_enabled),
				IsIncidentLogsEnabled:      pulumi.Any(_var.Data_guard_association_data_collection_options_is_incident_logs_enabled),
			},
			DatabaseSoftwareImageId:      pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
			DbSystemDefinedTags:          pulumi.Any(_var.Data_guard_association_db_system_defined_tags),
			DbSystemFreeformTags:         pulumi.Any(_var.Data_guard_association_db_system_freeform_tags),
			DisplayName:                  pulumi.Any(_var.Data_guard_association_display_name),
			FaultDomains:                 pulumi.Any(_var.Data_guard_association_fault_domains),
			Hostname:                     pulumi.Any(_var.Data_guard_association_hostname),
			IsActiveDataGuardEnabled:     pulumi.Any(_var.Data_guard_association_is_active_data_guard_enabled),
			LicenseModel:                 pulumi.Any(_var.Data_guard_association_license_model),
			NodeCount:                    pulumi.Any(_var.Data_guard_association_node_count),
			NsgIds:                       pulumi.Any(_var.Data_guard_association_nsg_ids),
			PeerDbHomeId:                 pulumi.Any(oci_database_db_home.Test_db_home.Id),
			PeerDbSystemId:               pulumi.Any(oci_database_db_system.Test_db_system.Id),
			PeerDbUniqueName:             pulumi.Any(_var.Data_guard_association_peer_db_unique_name),
			PeerSidPrefix:                pulumi.Any(_var.Data_guard_association_peer_sid_prefix),
			PeerVmClusterId:              pulumi.Any(oci_database_vm_cluster.Test_vm_cluster.Id),
			PrivateIp:                    pulumi.Any(_var.Data_guard_association_private_ip),
			Shape:                        pulumi.Any(_var.Data_guard_association_shape),
			StorageVolumePerformanceMode: pulumi.Any(_var.Data_guard_association_storage_volume_performance_mode),
			SubnetId:                     pulumi.Any(oci_core_subnet.Test_subnet.Id),
			TimeZone:                     pulumi.Any(_var.Data_guard_association_time_zone),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DataGuardAssociation;
import com.pulumi.oci.Database.DataGuardAssociationArgs;
import com.pulumi.oci.Database.inputs.DataGuardAssociationDataCollectionOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var testDataGuardAssociation = new DataGuardAssociation("testDataGuardAssociation", DataGuardAssociationArgs.builder()        
            .creationType(var_.data_guard_association_creation_type())
            .databaseAdminPassword(var_.data_guard_association_database_admin_password())
            .databaseId(oci_database_database.test_database().id())
            .deleteStandbyDbHomeOnDelete(var_.data_guard_association_delete_standby_db_home_on_delete())
            .protectionMode(var_.data_guard_association_protection_mode())
            .transportType(var_.data_guard_association_transport_type())
            .availabilityDomain(var_.data_guard_association_availability_domain())
            .backupNetworkNsgIds(var_.data_guard_association_backup_network_nsg_ids())
            .cpuCoreCount(var_.data_guard_association_cpu_core_count())
            .databaseDefinedTags(var_.data_guard_association_database_defined_tags())
            .databaseFreeformTags(var_.data_guard_association_database_freeform_tags())
            .dataCollectionOptions(DataGuardAssociationDataCollectionOptionsArgs.builder()
                .isDiagnosticsEventsEnabled(var_.data_guard_association_data_collection_options_is_diagnostics_events_enabled())
                .isHealthMonitoringEnabled(var_.data_guard_association_data_collection_options_is_health_monitoring_enabled())
                .isIncidentLogsEnabled(var_.data_guard_association_data_collection_options_is_incident_logs_enabled())
                .build())
            .databaseSoftwareImageId(oci_database_database_software_image.test_database_software_image().id())
            .dbSystemDefinedTags(var_.data_guard_association_db_system_defined_tags())
            .dbSystemFreeformTags(var_.data_guard_association_db_system_freeform_tags())
            .displayName(var_.data_guard_association_display_name())
            .faultDomains(var_.data_guard_association_fault_domains())
            .hostname(var_.data_guard_association_hostname())
            .isActiveDataGuardEnabled(var_.data_guard_association_is_active_data_guard_enabled())
            .licenseModel(var_.data_guard_association_license_model())
            .nodeCount(var_.data_guard_association_node_count())
            .nsgIds(var_.data_guard_association_nsg_ids())
            .peerDbHomeId(oci_database_db_home.test_db_home().id())
            .peerDbSystemId(oci_database_db_system.test_db_system().id())
            .peerDbUniqueName(var_.data_guard_association_peer_db_unique_name())
            .peerSidPrefix(var_.data_guard_association_peer_sid_prefix())
            .peerVmClusterId(oci_database_vm_cluster.test_vm_cluster().id())
            .privateIp(var_.data_guard_association_private_ip())
            .shape(var_.data_guard_association_shape())
            .storageVolumePerformanceMode(var_.data_guard_association_storage_volume_performance_mode())
            .subnetId(oci_core_subnet.test_subnet().id())
            .timeZone(var_.data_guard_association_time_zone())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_data_guard_association = oci.database.DataGuardAssociation("testDataGuardAssociation",
    creation_type=var["data_guard_association_creation_type"],
    database_admin_password=var["data_guard_association_database_admin_password"],
    database_id=oci_database_database["test_database"]["id"],
    delete_standby_db_home_on_delete=var["data_guard_association_delete_standby_db_home_on_delete"],
    protection_mode=var["data_guard_association_protection_mode"],
    transport_type=var["data_guard_association_transport_type"],
    availability_domain=var["data_guard_association_availability_domain"],
    backup_network_nsg_ids=var["data_guard_association_backup_network_nsg_ids"],
    cpu_core_count=var["data_guard_association_cpu_core_count"],
    database_defined_tags=var["data_guard_association_database_defined_tags"],
    database_freeform_tags=var["data_guard_association_database_freeform_tags"],
    data_collection_options=oci.database.DataGuardAssociationDataCollectionOptionsArgs(
        is_diagnostics_events_enabled=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
        is_health_monitoring_enabled=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
        is_incident_logs_enabled=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
    ),
    database_software_image_id=oci_database_database_software_image["test_database_software_image"]["id"],
    db_system_defined_tags=var["data_guard_association_db_system_defined_tags"],
    db_system_freeform_tags=var["data_guard_association_db_system_freeform_tags"],
    display_name=var["data_guard_association_display_name"],
    fault_domains=var["data_guard_association_fault_domains"],
    hostname=var["data_guard_association_hostname"],
    is_active_data_guard_enabled=var["data_guard_association_is_active_data_guard_enabled"],
    license_model=var["data_guard_association_license_model"],
    node_count=var["data_guard_association_node_count"],
    nsg_ids=var["data_guard_association_nsg_ids"],
    peer_db_home_id=oci_database_db_home["test_db_home"]["id"],
    peer_db_system_id=oci_database_db_system["test_db_system"]["id"],
    peer_db_unique_name=var["data_guard_association_peer_db_unique_name"],
    peer_sid_prefix=var["data_guard_association_peer_sid_prefix"],
    peer_vm_cluster_id=oci_database_vm_cluster["test_vm_cluster"]["id"],
    private_ip=var["data_guard_association_private_ip"],
    shape=var["data_guard_association_shape"],
    storage_volume_performance_mode=var["data_guard_association_storage_volume_performance_mode"],
    subnet_id=oci_core_subnet["test_subnet"]["id"],
    time_zone=var["data_guard_association_time_zone"])

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

const testDataGuardAssociation = new oci.database.DataGuardAssociation("testDataGuardAssociation", {
    creationType: _var.data_guard_association_creation_type,
    databaseAdminPassword: _var.data_guard_association_database_admin_password,
    databaseId: oci_database_database.test_database.id,
    deleteStandbyDbHomeOnDelete: _var.data_guard_association_delete_standby_db_home_on_delete,
    protectionMode: _var.data_guard_association_protection_mode,
    transportType: _var.data_guard_association_transport_type,
    availabilityDomain: _var.data_guard_association_availability_domain,
    backupNetworkNsgIds: _var.data_guard_association_backup_network_nsg_ids,
    cpuCoreCount: _var.data_guard_association_cpu_core_count,
    databaseDefinedTags: _var.data_guard_association_database_defined_tags,
    databaseFreeformTags: _var.data_guard_association_database_freeform_tags,
    dataCollectionOptions: {
        isDiagnosticsEventsEnabled: _var.data_guard_association_data_collection_options_is_diagnostics_events_enabled,
        isHealthMonitoringEnabled: _var.data_guard_association_data_collection_options_is_health_monitoring_enabled,
        isIncidentLogsEnabled: _var.data_guard_association_data_collection_options_is_incident_logs_enabled,
    },
    databaseSoftwareImageId: oci_database_database_software_image.test_database_software_image.id,
    dbSystemDefinedTags: _var.data_guard_association_db_system_defined_tags,
    dbSystemFreeformTags: _var.data_guard_association_db_system_freeform_tags,
    displayName: _var.data_guard_association_display_name,
    faultDomains: _var.data_guard_association_fault_domains,
    hostname: _var.data_guard_association_hostname,
    isActiveDataGuardEnabled: _var.data_guard_association_is_active_data_guard_enabled,
    licenseModel: _var.data_guard_association_license_model,
    nodeCount: _var.data_guard_association_node_count,
    nsgIds: _var.data_guard_association_nsg_ids,
    peerDbHomeId: oci_database_db_home.test_db_home.id,
    peerDbSystemId: oci_database_db_system.test_db_system.id,
    peerDbUniqueName: _var.data_guard_association_peer_db_unique_name,
    peerSidPrefix: _var.data_guard_association_peer_sid_prefix,
    peerVmClusterId: oci_database_vm_cluster.test_vm_cluster.id,
    privateIp: _var.data_guard_association_private_ip,
    shape: _var.data_guard_association_shape,
    storageVolumePerformanceMode: _var.data_guard_association_storage_volume_performance_mode,
    subnetId: oci_core_subnet.test_subnet.id,
    timeZone: _var.data_guard_association_time_zone,
});

resources:
  testDataGuardAssociation:
    type: oci:Database:DataGuardAssociation
    properties:
      #Required
      creationType: ${var.data_guard_association_creation_type}
      databaseAdminPassword: ${var.data_guard_association_database_admin_password}
      databaseId: ${oci_database_database.test_database.id}
      deleteStandbyDbHomeOnDelete: ${var.data_guard_association_delete_standby_db_home_on_delete}
      protectionMode: ${var.data_guard_association_protection_mode}
      transportType: ${var.data_guard_association_transport_type}
      #Optional
      availabilityDomain: ${var.data_guard_association_availability_domain}
      backupNetworkNsgIds: ${var.data_guard_association_backup_network_nsg_ids}
      cpuCoreCount: ${var.data_guard_association_cpu_core_count}
      databaseDefinedTags: ${var.data_guard_association_database_defined_tags}
      databaseFreeformTags: ${var.data_guard_association_database_freeform_tags}
      dataCollectionOptions:
        isDiagnosticsEventsEnabled: ${var.data_guard_association_data_collection_options_is_diagnostics_events_enabled}
        isHealthMonitoringEnabled: ${var.data_guard_association_data_collection_options_is_health_monitoring_enabled}
        isIncidentLogsEnabled: ${var.data_guard_association_data_collection_options_is_incident_logs_enabled}
      databaseSoftwareImageId: ${oci_database_database_software_image.test_database_software_image.id}
      dbSystemDefinedTags: ${var.data_guard_association_db_system_defined_tags}
      dbSystemFreeformTags: ${var.data_guard_association_db_system_freeform_tags}
      displayName: ${var.data_guard_association_display_name}
      faultDomains: ${var.data_guard_association_fault_domains}
      hostname: ${var.data_guard_association_hostname}
      isActiveDataGuardEnabled: ${var.data_guard_association_is_active_data_guard_enabled}
      licenseModel: ${var.data_guard_association_license_model}
      nodeCount: ${var.data_guard_association_node_count}
      nsgIds: ${var.data_guard_association_nsg_ids}
      peerDbHomeId: ${oci_database_db_home.test_db_home.id}
      peerDbSystemId: ${oci_database_db_system.test_db_system.id}
      peerDbUniqueName: ${var.data_guard_association_peer_db_unique_name}
      peerSidPrefix: ${var.data_guard_association_peer_sid_prefix}
      peerVmClusterId: ${oci_database_vm_cluster.test_vm_cluster.id}
      privateIp: ${var.data_guard_association_private_ip}
      shape: ${var.data_guard_association_shape}
      storageVolumePerformanceMode: ${var.data_guard_association_storage_volume_performance_mode}
      subnetId: ${oci_core_subnet.test_subnet.id}
      timeZone: ${var.data_guard_association_time_zone}

Create DataGuardAssociation Resource

new DataGuardAssociation(name: string, args: DataGuardAssociationArgs, opts?: CustomResourceOptions);
@overload
def DataGuardAssociation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         availability_domain: Optional[str] = None,
                         backup_network_nsg_ids: Optional[Sequence[str]] = None,
                         cpu_core_count: Optional[int] = None,
                         create_async: Optional[bool] = None,
                         creation_type: Optional[str] = None,
                         data_collection_options: Optional[_database.DataGuardAssociationDataCollectionOptionsArgs] = None,
                         database_admin_password: Optional[str] = None,
                         database_defined_tags: Optional[Mapping[str, Any]] = None,
                         database_freeform_tags: Optional[Mapping[str, Any]] = None,
                         database_id: Optional[str] = None,
                         database_software_image_id: Optional[str] = None,
                         db_system_defined_tags: Optional[Mapping[str, Any]] = None,
                         db_system_freeform_tags: Optional[Mapping[str, Any]] = None,
                         delete_standby_db_home_on_delete: Optional[str] = None,
                         display_name: Optional[str] = None,
                         fault_domains: Optional[Sequence[str]] = None,
                         hostname: Optional[str] = None,
                         is_active_data_guard_enabled: Optional[bool] = None,
                         license_model: Optional[str] = None,
                         node_count: Optional[int] = None,
                         nsg_ids: Optional[Sequence[str]] = None,
                         peer_db_home_id: Optional[str] = None,
                         peer_db_system_id: Optional[str] = None,
                         peer_db_unique_name: Optional[str] = None,
                         peer_sid_prefix: Optional[str] = None,
                         peer_vm_cluster_id: Optional[str] = None,
                         private_ip: Optional[str] = None,
                         protection_mode: Optional[str] = None,
                         shape: Optional[str] = None,
                         storage_volume_performance_mode: Optional[str] = None,
                         subnet_id: Optional[str] = None,
                         time_zone: Optional[str] = None,
                         transport_type: Optional[str] = None)
@overload
def DataGuardAssociation(resource_name: str,
                         args: DataGuardAssociationArgs,
                         opts: Optional[ResourceOptions] = None)
func NewDataGuardAssociation(ctx *Context, name string, args DataGuardAssociationArgs, opts ...ResourceOption) (*DataGuardAssociation, error)
public DataGuardAssociation(string name, DataGuardAssociationArgs args, CustomResourceOptions? opts = null)
public DataGuardAssociation(String name, DataGuardAssociationArgs args)
public DataGuardAssociation(String name, DataGuardAssociationArgs args, CustomResourceOptions options)

type: oci:Database:DataGuardAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DataGuardAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DataGuardAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DataGuardAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DataGuardAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DataGuardAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DataGuardAssociation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DataGuardAssociation resource accepts the following input properties:

CreationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

DatabaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

DatabaseId string

The database OCID.

DeleteStandbyDbHomeOnDelete string
ProtectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

TransportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

AvailabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

BackupNetworkNsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

CpuCoreCount int

The number of OCPU cores available for AMD-based virtual machine DB systems.

CreateAsync bool
DataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DatabaseDefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DatabaseFreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DatabaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

DbSystemDefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DbSystemFreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DisplayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

FaultDomains List<string>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LicenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

NodeCount int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

NsgIds List<string>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
PeerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

PeerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

PeerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

PeerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

PeerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

PrivateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

Shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

TimeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

CreationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

DatabaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

DatabaseId string

The database OCID.

DeleteStandbyDbHomeOnDelete string
ProtectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

TransportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

AvailabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

BackupNetworkNsgIds []string

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

CpuCoreCount int

The number of OCPU cores available for AMD-based virtual machine DB systems.

CreateAsync bool
DataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DatabaseDefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DatabaseFreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DatabaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

DbSystemDefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DbSystemFreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DisplayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

FaultDomains []string

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LicenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

NodeCount int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

NsgIds []string

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
PeerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

PeerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

PeerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

PeerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

PeerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

PrivateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

Shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

TimeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

creationType String

Specifies whether to create the peer database in an existing DB system or in a new DB system.

databaseAdminPassword String

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseId String

The database OCID.

deleteStandbyDbHomeOnDelete String
protectionMode String

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

transportType String

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availabilityDomain String

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount Integer

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync Boolean
dataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseDefinedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseSoftwareImageId String

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

displayName String

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains List<String>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

licenseModel String

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

nodeCount Integer

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds List<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDbHomeId String

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId String

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerSidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId String

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp String

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

shape String

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeZone String

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

creationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

databaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseId string

The database OCID.

deleteStandbyDbHomeOnDelete string
protectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

transportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds string[]

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount number

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync boolean
dataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseDefinedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

displayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains string[]

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname string

The hostname for the DB node.

isActiveDataGuardEnabled boolean

(Updatable) True if active Data Guard is enabled.

licenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

nodeCount number

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds string[]

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

storageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

creation_type str

Specifies whether to create the peer database in an existing DB system or in a new DB system.

database_admin_password str

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

database_id str

The database OCID.

delete_standby_db_home_on_delete str
protection_mode str

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

transport_type str

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availability_domain str

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backup_network_nsg_ids Sequence[str]

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpu_core_count int

The number of OCPU cores available for AMD-based virtual machine DB systems.

create_async bool
data_collection_options DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

database_defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

database_software_image_id str

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

db_system_defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_system_freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

display_name str

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

fault_domains Sequence[str]

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname str

The hostname for the DB node.

is_active_data_guard_enabled bool

(Updatable) True if active Data Guard is enabled.

license_model str

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

node_count int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsg_ids Sequence[str]

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peer_db_home_id str

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peer_db_system_id str

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peer_db_unique_name str

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peer_sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

peer_vm_cluster_id str

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

private_ip str

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

shape str

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

storage_volume_performance_mode str

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnet_id str

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

time_zone str

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

creationType String

Specifies whether to create the peer database in an existing DB system or in a new DB system.

databaseAdminPassword String

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseId String

The database OCID.

deleteStandbyDbHomeOnDelete String
protectionMode String

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

transportType String

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availabilityDomain String

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount Number

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync Boolean
dataCollectionOptions Property Map

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseDefinedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseSoftwareImageId String

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

displayName String

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains List<String>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

licenseModel String

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

nodeCount Number

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds List<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDbHomeId String

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId String

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerSidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId String

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp String

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

shape String

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeZone String

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

Outputs

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

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

PeerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

PeerDatabaseId string

The OCID of the associated peer database.

PeerRole string

The role of the peer database in this Data Guard association.

Role string

The role of the reporting database in this Data Guard association.

State string

The current state of the Data Guard association.

TimeCreated string

The date and time the Data Guard association was created.

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

PeerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

PeerDatabaseId string

The OCID of the associated peer database.

PeerRole string

The role of the peer database in this Data Guard association.

Role string

The role of the reporting database in this Data Guard association.

State string

The current state of the Data Guard association.

TimeCreated string

The date and time the Data Guard association was created.

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

peerDataGuardAssociationId String

The OCID of the peer database's Data Guard association.

peerDatabaseId String

The OCID of the associated peer database.

peerRole String

The role of the peer database in this Data Guard association.

role String

The role of the reporting database in this Data Guard association.

state String

The current state of the Data Guard association.

timeCreated String

The date and time the Data Guard association was created.

applyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

Additional information about the current lifecycleState, if available.

peerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

peerDatabaseId string

The OCID of the associated peer database.

peerRole string

The role of the peer database in this Data Guard association.

role string

The role of the reporting database in this Data Guard association.

state string

The current state of the Data Guard association.

timeCreated string

The date and time the Data Guard association was created.

apply_lag str

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

apply_rate str

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

Additional information about the current lifecycleState, if available.

peer_data_guard_association_id str

The OCID of the peer database's Data Guard association.

peer_database_id str

The OCID of the associated peer database.

peer_role str

The role of the peer database in this Data Guard association.

role str

The role of the reporting database in this Data Guard association.

state str

The current state of the Data Guard association.

time_created str

The date and time the Data Guard association was created.

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

peerDataGuardAssociationId String

The OCID of the peer database's Data Guard association.

peerDatabaseId String

The OCID of the associated peer database.

peerRole String

The role of the peer database in this Data Guard association.

role String

The role of the reporting database in this Data Guard association.

state String

The current state of the Data Guard association.

timeCreated String

The date and time the Data Guard association was created.

Look up Existing DataGuardAssociation Resource

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

public static get(name: string, id: Input<ID>, state?: DataGuardAssociationState, opts?: CustomResourceOptions): DataGuardAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_lag: Optional[str] = None,
        apply_rate: Optional[str] = None,
        availability_domain: Optional[str] = None,
        backup_network_nsg_ids: Optional[Sequence[str]] = None,
        cpu_core_count: Optional[int] = None,
        create_async: Optional[bool] = None,
        creation_type: Optional[str] = None,
        data_collection_options: Optional[_database.DataGuardAssociationDataCollectionOptionsArgs] = None,
        database_admin_password: Optional[str] = None,
        database_defined_tags: Optional[Mapping[str, Any]] = None,
        database_freeform_tags: Optional[Mapping[str, Any]] = None,
        database_id: Optional[str] = None,
        database_software_image_id: Optional[str] = None,
        db_system_defined_tags: Optional[Mapping[str, Any]] = None,
        db_system_freeform_tags: Optional[Mapping[str, Any]] = None,
        delete_standby_db_home_on_delete: Optional[str] = None,
        display_name: Optional[str] = None,
        fault_domains: Optional[Sequence[str]] = None,
        hostname: Optional[str] = None,
        is_active_data_guard_enabled: Optional[bool] = None,
        license_model: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        node_count: Optional[int] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        peer_data_guard_association_id: Optional[str] = None,
        peer_database_id: Optional[str] = None,
        peer_db_home_id: Optional[str] = None,
        peer_db_system_id: Optional[str] = None,
        peer_db_unique_name: Optional[str] = None,
        peer_role: Optional[str] = None,
        peer_sid_prefix: Optional[str] = None,
        peer_vm_cluster_id: Optional[str] = None,
        private_ip: Optional[str] = None,
        protection_mode: Optional[str] = None,
        role: Optional[str] = None,
        shape: Optional[str] = None,
        state: Optional[str] = None,
        storage_volume_performance_mode: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_zone: Optional[str] = None,
        transport_type: Optional[str] = None) -> DataGuardAssociation
func GetDataGuardAssociation(ctx *Context, name string, id IDInput, state *DataGuardAssociationState, opts ...ResourceOption) (*DataGuardAssociation, error)
public static DataGuardAssociation Get(string name, Input<string> id, DataGuardAssociationState? state, CustomResourceOptions? opts = null)
public static DataGuardAssociation get(String name, Output<String> id, DataGuardAssociationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

AvailabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

BackupNetworkNsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

CpuCoreCount int

The number of OCPU cores available for AMD-based virtual machine DB systems.

CreateAsync bool
CreationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

DataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DatabaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

DatabaseDefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DatabaseFreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DatabaseId string

The database OCID.

DatabaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

DbSystemDefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DbSystemFreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DeleteStandbyDbHomeOnDelete string
DisplayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

FaultDomains List<string>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LicenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

NodeCount int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

NsgIds List<string>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
PeerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

PeerDatabaseId string

The OCID of the associated peer database.

PeerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

PeerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

PeerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

PeerRole string

The role of the peer database in this Data Guard association.

PeerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

PeerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

PrivateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

ProtectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

Role string

The role of the reporting database in this Data Guard association.

Shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

State string

The current state of the Data Guard association.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

TimeCreated string

The date and time the Data Guard association was created.

TimeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

TransportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

AvailabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

BackupNetworkNsgIds []string

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

CpuCoreCount int

The number of OCPU cores available for AMD-based virtual machine DB systems.

CreateAsync bool
CreationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

DataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

DatabaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

DatabaseDefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DatabaseFreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DatabaseId string

The database OCID.

DatabaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

DbSystemDefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

DbSystemFreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

DeleteStandbyDbHomeOnDelete string
DisplayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

FaultDomains []string

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LicenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

NodeCount int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

NsgIds []string

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
PeerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

PeerDatabaseId string

The OCID of the associated peer database.

PeerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

PeerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

PeerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

PeerRole string

The role of the peer database in this Data Guard association.

PeerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

PeerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

PrivateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

ProtectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

Role string

The role of the reporting database in this Data Guard association.

Shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

State string

The current state of the Data Guard association.

StorageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

SubnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

TimeCreated string

The date and time the Data Guard association was created.

TimeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

TransportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

availabilityDomain String

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount Integer

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync Boolean
creationType String

Specifies whether to create the peer database in an existing DB system or in a new DB system.

dataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseAdminPassword String

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseDefinedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseId String

The database OCID.

databaseSoftwareImageId String

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

deleteStandbyDbHomeOnDelete String
displayName String

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains List<String>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

licenseModel String

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

nodeCount Integer

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds List<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDataGuardAssociationId String

The OCID of the peer database's Data Guard association.

peerDatabaseId String

The OCID of the associated peer database.

peerDbHomeId String

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId String

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerRole String

The role of the peer database in this Data Guard association.

peerSidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId String

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp String

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

protectionMode String

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

role String

The role of the reporting database in this Data Guard association.

shape String

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

state String

The current state of the Data Guard association.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeCreated String

The date and time the Data Guard association was created.

timeZone String

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

transportType String

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

applyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate string

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

availabilityDomain string

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds string[]

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount number

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync boolean
creationType string

Specifies whether to create the peer database in an existing DB system or in a new DB system.

dataCollectionOptions DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseAdminPassword string

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseDefinedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseId string

The database OCID.

databaseSoftwareImageId string

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

deleteStandbyDbHomeOnDelete string
displayName string

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains string[]

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname string

The hostname for the DB node.

isActiveDataGuardEnabled boolean

(Updatable) True if active Data Guard is enabled.

licenseModel string

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

lifecycleDetails string

Additional information about the current lifecycleState, if available.

nodeCount number

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds string[]

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDataGuardAssociationId string

The OCID of the peer database's Data Guard association.

peerDatabaseId string

The OCID of the associated peer database.

peerDbHomeId string

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId string

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerRole string

The role of the peer database in this Data Guard association.

peerSidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId string

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp string

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

protectionMode string

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

role string

The role of the reporting database in this Data Guard association.

shape string

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

state string

The current state of the Data Guard association.

storageVolumePerformanceMode string

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId string

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeCreated string

The date and time the Data Guard association was created.

timeZone string

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

transportType string

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

apply_lag str

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

apply_rate str

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

availability_domain str

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backup_network_nsg_ids Sequence[str]

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpu_core_count int

The number of OCPU cores available for AMD-based virtual machine DB systems.

create_async bool
creation_type str

Specifies whether to create the peer database in an existing DB system or in a new DB system.

data_collection_options DataGuardAssociationDataCollectionOptionsArgs

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

database_admin_password str

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

database_defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

database_freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

database_id str

The database OCID.

database_software_image_id str

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

db_system_defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

db_system_freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

delete_standby_db_home_on_delete str
display_name str

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

fault_domains Sequence[str]

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname str

The hostname for the DB node.

is_active_data_guard_enabled bool

(Updatable) True if active Data Guard is enabled.

license_model str

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

lifecycle_details str

Additional information about the current lifecycleState, if available.

node_count int

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsg_ids Sequence[str]

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peer_data_guard_association_id str

The OCID of the peer database's Data Guard association.

peer_database_id str

The OCID of the associated peer database.

peer_db_home_id str

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peer_db_system_id str

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peer_db_unique_name str

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peer_role str

The role of the peer database in this Data Guard association.

peer_sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

peer_vm_cluster_id str

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

private_ip str

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

protection_mode str

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

role str

The role of the reporting database in this Data Guard association.

shape str

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

state str

The current state of the Data Guard association.

storage_volume_performance_mode str

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnet_id str

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

time_created str

The date and time the Data Guard association was created.

time_zone str

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

transport_type str

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 9 seconds

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 180 Mb per second

availabilityDomain String

The name of the availability domain that the standby database DB system will be located in. For example- "Uocm:PHX-AD-1".

backupNetworkNsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

cpuCoreCount Number

The number of OCPU cores available for AMD-based virtual machine DB systems.

createAsync Boolean
creationType String

Specifies whether to create the peer database in an existing DB system or in a new DB system.

dataCollectionOptions Property Map

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

databaseAdminPassword String

(Updatable) A strong password for the SYS, SYSTEM, and PDB Admin users to apply during standby creation.

The password must contain no fewer than nine characters and include:

  • At least two uppercase characters.
  • At least two lowercase characters.
  • At least two numeric characters.
  • At least two special characters. Valid special characters include "_", "#", and "-" only.

The password MUST be the same as the primary admin password.

databaseDefinedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

databaseFreeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

databaseId String

The database OCID.

databaseSoftwareImageId String

The database software image OCID. Applicable only when creationType=ExistingDbSystem and when the existing database has Exadata shape.

dbSystemDefinedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

dbSystemFreeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

deleteStandbyDbHomeOnDelete String
displayName String

The user-friendly name of the DB system that will contain the the standby database. The display name does not have to be unique.

faultDomains List<String>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

licenseModel String

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

nodeCount Number

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system.

nsgIds List<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
peerDataGuardAssociationId String

The OCID of the peer database's Data Guard association.

peerDatabaseId String

The OCID of the associated peer database.

peerDbHomeId String

The OCID of the DB home in which to create the standby database. You must supply this value to create standby database with an existing DB home

peerDbSystemId String

The OCID of the DB system in which to create the standby database. You must supply this value if creationType is ExistingDbSystem.

peerDbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

peerRole String

The role of the peer database in this Data Guard association.

peerSidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

peerVmClusterId String

The OCID of the VM Cluster in which to create the standby database. You must supply this value if creationType is ExistingVmCluster.

privateIp String

The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet.

protectionMode String

(Updatable) The protection mode to set up between the primary and standby databases. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

IMPORTANT - The only protection mode currently supported by the Database service is MAXIMUM_PERFORMANCE.

role String

The role of the reporting database in this Data Guard association.

shape String

The virtual machine DB system shape to launch for the standby database in the Data Guard association. The shape determines the number of CPU cores and the amount of memory available for the DB system. Only virtual machine shapes are valid options. If you do not supply this parameter, the default shape is the shape of the primary DB system.

To get a list of all shapes, use the ListDbSystemShapes operation.

state String

The current state of the Data Guard association.

storageVolumePerformanceMode String

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

subnetId String

The OCID of the subnet the DB system is associated with. Subnet Restrictions:

  • For 1- and 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.16.16/28

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

timeCreated String

The date and time the Data Guard association was created.

timeZone String

The time zone of the dataguard standby DB system. For details, see DB System Time Zones.

transportType String

(Updatable) The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

  • MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
  • MAXIMUM_PERFORMANCE - ASYNC
  • MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Supporting Types

DataGuardAssociationDataCollectionOptions

IsDiagnosticsEventsEnabled bool

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

IsHealthMonitoringEnabled bool

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

IsIncidentLogsEnabled bool

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

IsDiagnosticsEventsEnabled bool

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

IsHealthMonitoringEnabled bool

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

IsIncidentLogsEnabled bool

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

isHealthMonitoringEnabled Boolean

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

isIncidentLogsEnabled Boolean

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled boolean

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

isHealthMonitoringEnabled boolean

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

isIncidentLogsEnabled boolean

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

is_diagnostics_events_enabled bool

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

is_health_monitoring_enabled bool

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

is_incident_logs_enabled bool

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

isDiagnosticsEventsEnabled Boolean

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

isHealthMonitoringEnabled Boolean

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

isIncidentLogsEnabled Boolean

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

Import

Import is not supported for this resource.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.