Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Database.DataGuardAssociation

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

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

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

const testDataGuardAssociation = new oci.database.DataGuardAssociation("test_data_guard_association", {
    creationType: dataGuardAssociationCreationType,
    databaseAdminPassword: dataGuardAssociationDatabaseAdminPassword,
    databaseId: testDatabase.id,
    deleteStandbyDbHomeOnDelete: dataGuardAssociationDeleteStandbyDbHomeOnDelete,
    protectionMode: dataGuardAssociationProtectionMode,
    transportType: dataGuardAssociationTransportType,
    availabilityDomain: dataGuardAssociationAvailabilityDomain,
    backupNetworkNsgIds: dataGuardAssociationBackupNetworkNsgIds,
    cpuCoreCount: dataGuardAssociationCpuCoreCount,
    databaseDefinedTags: dataGuardAssociationDatabaseDefinedTags,
    databaseFreeformTags: dataGuardAssociationDatabaseFreeformTags,
    dataCollectionOptions: {
        isDiagnosticsEventsEnabled: dataGuardAssociationDataCollectionOptionsIsDiagnosticsEventsEnabled,
        isHealthMonitoringEnabled: dataGuardAssociationDataCollectionOptionsIsHealthMonitoringEnabled,
        isIncidentLogsEnabled: dataGuardAssociationDataCollectionOptionsIsIncidentLogsEnabled,
    },
    databaseSoftwareImageId: testDatabaseSoftwareImage.id,
    dbSystemDefinedTags: dataGuardAssociationDbSystemDefinedTags,
    dbSystemFreeformTags: dataGuardAssociationDbSystemFreeformTags,
    dbSystemSecurityAttributes: dataGuardAssociationDbSystemSecurityAttributes,
    displayName: dataGuardAssociationDisplayName,
    domain: dataGuardAssociationDomain,
    faultDomains: dataGuardAssociationFaultDomains,
    hostname: dataGuardAssociationHostname,
    isActiveDataGuardEnabled: dataGuardAssociationIsActiveDataGuardEnabled,
    licenseModel: dataGuardAssociationLicenseModel,
    nodeCount: dataGuardAssociationNodeCount,
    nsgIds: dataGuardAssociationNsgIds,
    peerDbHomeId: testDbHome.id,
    peerDbSystemId: testDbSystem.id,
    peerDbUniqueName: dataGuardAssociationPeerDbUniqueName,
    peerSidPrefix: dataGuardAssociationPeerSidPrefix,
    peerVmClusterId: testVmCluster.id,
    privateIp: dataGuardAssociationPrivateIp,
    privateIpV6: dataGuardAssociationPrivateIpV6,
    shape: dataGuardAssociationShape,
    storageVolumePerformanceMode: dataGuardAssociationStorageVolumePerformanceMode,
    subnetId: testSubnet.id,
    timeZone: dataGuardAssociationTimeZone,
});

import pulumi
import pulumi_oci as oci

test_data_guard_association = oci.database.DataGuardAssociation("test_data_guard_association",
    creation_type=data_guard_association_creation_type,
    database_admin_password=data_guard_association_database_admin_password,
    database_id=test_database["id"],
    delete_standby_db_home_on_delete=data_guard_association_delete_standby_db_home_on_delete,
    protection_mode=data_guard_association_protection_mode,
    transport_type=data_guard_association_transport_type,
    availability_domain=data_guard_association_availability_domain,
    backup_network_nsg_ids=data_guard_association_backup_network_nsg_ids,
    cpu_core_count=data_guard_association_cpu_core_count,
    database_defined_tags=data_guard_association_database_defined_tags,
    database_freeform_tags=data_guard_association_database_freeform_tags,
    data_collection_options={
        "is_diagnostics_events_enabled": data_guard_association_data_collection_options_is_diagnostics_events_enabled,
        "is_health_monitoring_enabled": data_guard_association_data_collection_options_is_health_monitoring_enabled,
        "is_incident_logs_enabled": data_guard_association_data_collection_options_is_incident_logs_enabled,
    },
    database_software_image_id=test_database_software_image["id"],
    db_system_defined_tags=data_guard_association_db_system_defined_tags,
    db_system_freeform_tags=data_guard_association_db_system_freeform_tags,
    db_system_security_attributes=data_guard_association_db_system_security_attributes,
    display_name=data_guard_association_display_name,
    domain=data_guard_association_domain,
    fault_domains=data_guard_association_fault_domains,
    hostname=data_guard_association_hostname,
    is_active_data_guard_enabled=data_guard_association_is_active_data_guard_enabled,
    license_model=data_guard_association_license_model,
    node_count=data_guard_association_node_count,
    nsg_ids=data_guard_association_nsg_ids,
    peer_db_home_id=test_db_home["id"],
    peer_db_system_id=test_db_system["id"],
    peer_db_unique_name=data_guard_association_peer_db_unique_name,
    peer_sid_prefix=data_guard_association_peer_sid_prefix,
    peer_vm_cluster_id=test_vm_cluster["id"],
    private_ip=data_guard_association_private_ip,
    private_ip_v6=data_guard_association_private_ip_v6,
    shape=data_guard_association_shape,
    storage_volume_performance_mode=data_guard_association_storage_volume_performance_mode,
    subnet_id=test_subnet["id"],
    time_zone=data_guard_association_time_zone)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.NewDataGuardAssociation(ctx, "test_data_guard_association", &database.DataGuardAssociationArgs{
			CreationType:                pulumi.Any(dataGuardAssociationCreationType),
			DatabaseAdminPassword:       pulumi.Any(dataGuardAssociationDatabaseAdminPassword),
			DatabaseId:                  pulumi.Any(testDatabase.Id),
			DeleteStandbyDbHomeOnDelete: pulumi.Any(dataGuardAssociationDeleteStandbyDbHomeOnDelete),
			ProtectionMode:              pulumi.Any(dataGuardAssociationProtectionMode),
			TransportType:               pulumi.Any(dataGuardAssociationTransportType),
			AvailabilityDomain:          pulumi.Any(dataGuardAssociationAvailabilityDomain),
			BackupNetworkNsgIds:         pulumi.Any(dataGuardAssociationBackupNetworkNsgIds),
			CpuCoreCount:                pulumi.Any(dataGuardAssociationCpuCoreCount),
			DatabaseDefinedTags:         pulumi.Any(dataGuardAssociationDatabaseDefinedTags),
			DatabaseFreeformTags:        pulumi.Any(dataGuardAssociationDatabaseFreeformTags),
			DataCollectionOptions: &database.DataGuardAssociationDataCollectionOptionsArgs{
				IsDiagnosticsEventsEnabled: pulumi.Any(dataGuardAssociationDataCollectionOptionsIsDiagnosticsEventsEnabled),
				IsHealthMonitoringEnabled:  pulumi.Any(dataGuardAssociationDataCollectionOptionsIsHealthMonitoringEnabled),
				IsIncidentLogsEnabled:      pulumi.Any(dataGuardAssociationDataCollectionOptionsIsIncidentLogsEnabled),
			},
			DatabaseSoftwareImageId:      pulumi.Any(testDatabaseSoftwareImage.Id),
			DbSystemDefinedTags:          pulumi.Any(dataGuardAssociationDbSystemDefinedTags),
			DbSystemFreeformTags:         pulumi.Any(dataGuardAssociationDbSystemFreeformTags),
			DbSystemSecurityAttributes:   pulumi.Any(dataGuardAssociationDbSystemSecurityAttributes),
			DisplayName:                  pulumi.Any(dataGuardAssociationDisplayName),
			Domain:                       pulumi.Any(dataGuardAssociationDomain),
			FaultDomains:                 pulumi.Any(dataGuardAssociationFaultDomains),
			Hostname:                     pulumi.Any(dataGuardAssociationHostname),
			IsActiveDataGuardEnabled:     pulumi.Any(dataGuardAssociationIsActiveDataGuardEnabled),
			LicenseModel:                 pulumi.Any(dataGuardAssociationLicenseModel),
			NodeCount:                    pulumi.Any(dataGuardAssociationNodeCount),
			NsgIds:                       pulumi.Any(dataGuardAssociationNsgIds),
			PeerDbHomeId:                 pulumi.Any(testDbHome.Id),
			PeerDbSystemId:               pulumi.Any(testDbSystem.Id),
			PeerDbUniqueName:             pulumi.Any(dataGuardAssociationPeerDbUniqueName),
			PeerSidPrefix:                pulumi.Any(dataGuardAssociationPeerSidPrefix),
			PeerVmClusterId:              pulumi.Any(testVmCluster.Id),
			PrivateIp:                    pulumi.Any(dataGuardAssociationPrivateIp),
			PrivateIpV6:                  pulumi.Any(dataGuardAssociationPrivateIpV6),
			Shape:                        pulumi.Any(dataGuardAssociationShape),
			StorageVolumePerformanceMode: pulumi.Any(dataGuardAssociationStorageVolumePerformanceMode),
			SubnetId:                     pulumi.Any(testSubnet.Id),
			TimeZone:                     pulumi.Any(dataGuardAssociationTimeZone),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDataGuardAssociation = new Oci.Database.DataGuardAssociation("test_data_guard_association", new()
    {
        CreationType = dataGuardAssociationCreationType,
        DatabaseAdminPassword = dataGuardAssociationDatabaseAdminPassword,
        DatabaseId = testDatabase.Id,
        DeleteStandbyDbHomeOnDelete = dataGuardAssociationDeleteStandbyDbHomeOnDelete,
        ProtectionMode = dataGuardAssociationProtectionMode,
        TransportType = dataGuardAssociationTransportType,
        AvailabilityDomain = dataGuardAssociationAvailabilityDomain,
        BackupNetworkNsgIds = dataGuardAssociationBackupNetworkNsgIds,
        CpuCoreCount = dataGuardAssociationCpuCoreCount,
        DatabaseDefinedTags = dataGuardAssociationDatabaseDefinedTags,
        DatabaseFreeformTags = dataGuardAssociationDatabaseFreeformTags,
        DataCollectionOptions = new Oci.Database.Inputs.DataGuardAssociationDataCollectionOptionsArgs
        {
            IsDiagnosticsEventsEnabled = dataGuardAssociationDataCollectionOptionsIsDiagnosticsEventsEnabled,
            IsHealthMonitoringEnabled = dataGuardAssociationDataCollectionOptionsIsHealthMonitoringEnabled,
            IsIncidentLogsEnabled = dataGuardAssociationDataCollectionOptionsIsIncidentLogsEnabled,
        },
        DatabaseSoftwareImageId = testDatabaseSoftwareImage.Id,
        DbSystemDefinedTags = dataGuardAssociationDbSystemDefinedTags,
        DbSystemFreeformTags = dataGuardAssociationDbSystemFreeformTags,
        DbSystemSecurityAttributes = dataGuardAssociationDbSystemSecurityAttributes,
        DisplayName = dataGuardAssociationDisplayName,
        Domain = dataGuardAssociationDomain,
        FaultDomains = dataGuardAssociationFaultDomains,
        Hostname = dataGuardAssociationHostname,
        IsActiveDataGuardEnabled = dataGuardAssociationIsActiveDataGuardEnabled,
        LicenseModel = dataGuardAssociationLicenseModel,
        NodeCount = dataGuardAssociationNodeCount,
        NsgIds = dataGuardAssociationNsgIds,
        PeerDbHomeId = testDbHome.Id,
        PeerDbSystemId = testDbSystem.Id,
        PeerDbUniqueName = dataGuardAssociationPeerDbUniqueName,
        PeerSidPrefix = dataGuardAssociationPeerSidPrefix,
        PeerVmClusterId = testVmCluster.Id,
        PrivateIp = dataGuardAssociationPrivateIp,
        PrivateIpV6 = dataGuardAssociationPrivateIpV6,
        Shape = dataGuardAssociationShape,
        StorageVolumePerformanceMode = dataGuardAssociationStorageVolumePerformanceMode,
        SubnetId = testSubnet.Id,
        TimeZone = dataGuardAssociationTimeZone,
    });

});

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(dataGuardAssociationCreationType)
            .databaseAdminPassword(dataGuardAssociationDatabaseAdminPassword)
            .databaseId(testDatabase.id())
            .deleteStandbyDbHomeOnDelete(dataGuardAssociationDeleteStandbyDbHomeOnDelete)
            .protectionMode(dataGuardAssociationProtectionMode)
            .transportType(dataGuardAssociationTransportType)
            .availabilityDomain(dataGuardAssociationAvailabilityDomain)
            .backupNetworkNsgIds(dataGuardAssociationBackupNetworkNsgIds)
            .cpuCoreCount(dataGuardAssociationCpuCoreCount)
            .databaseDefinedTags(dataGuardAssociationDatabaseDefinedTags)
            .databaseFreeformTags(dataGuardAssociationDatabaseFreeformTags)
            .dataCollectionOptions(DataGuardAssociationDataCollectionOptionsArgs.builder()
                .isDiagnosticsEventsEnabled(dataGuardAssociationDataCollectionOptionsIsDiagnosticsEventsEnabled)
                .isHealthMonitoringEnabled(dataGuardAssociationDataCollectionOptionsIsHealthMonitoringEnabled)
                .isIncidentLogsEnabled(dataGuardAssociationDataCollectionOptionsIsIncidentLogsEnabled)
                .build())
            .databaseSoftwareImageId(testDatabaseSoftwareImage.id())
            .dbSystemDefinedTags(dataGuardAssociationDbSystemDefinedTags)
            .dbSystemFreeformTags(dataGuardAssociationDbSystemFreeformTags)
            .dbSystemSecurityAttributes(dataGuardAssociationDbSystemSecurityAttributes)
            .displayName(dataGuardAssociationDisplayName)
            .domain(dataGuardAssociationDomain)
            .faultDomains(dataGuardAssociationFaultDomains)
            .hostname(dataGuardAssociationHostname)
            .isActiveDataGuardEnabled(dataGuardAssociationIsActiveDataGuardEnabled)
            .licenseModel(dataGuardAssociationLicenseModel)
            .nodeCount(dataGuardAssociationNodeCount)
            .nsgIds(dataGuardAssociationNsgIds)
            .peerDbHomeId(testDbHome.id())
            .peerDbSystemId(testDbSystem.id())
            .peerDbUniqueName(dataGuardAssociationPeerDbUniqueName)
            .peerSidPrefix(dataGuardAssociationPeerSidPrefix)
            .peerVmClusterId(testVmCluster.id())
            .privateIp(dataGuardAssociationPrivateIp)
            .privateIpV6(dataGuardAssociationPrivateIpV6)
            .shape(dataGuardAssociationShape)
            .storageVolumePerformanceMode(dataGuardAssociationStorageVolumePerformanceMode)
            .subnetId(testSubnet.id())
            .timeZone(dataGuardAssociationTimeZone)
            .build());

    }
}

resources:
  testDataGuardAssociation:
    type: oci:Database:DataGuardAssociation
    name: test_data_guard_association
    properties:
      creationType: ${dataGuardAssociationCreationType}
      databaseAdminPassword: ${dataGuardAssociationDatabaseAdminPassword}
      databaseId: ${testDatabase.id}
      deleteStandbyDbHomeOnDelete: ${dataGuardAssociationDeleteStandbyDbHomeOnDelete}
      protectionMode: ${dataGuardAssociationProtectionMode}
      transportType: ${dataGuardAssociationTransportType}
      availabilityDomain: ${dataGuardAssociationAvailabilityDomain}
      backupNetworkNsgIds: ${dataGuardAssociationBackupNetworkNsgIds}
      cpuCoreCount: ${dataGuardAssociationCpuCoreCount}
      databaseDefinedTags: ${dataGuardAssociationDatabaseDefinedTags}
      databaseFreeformTags: ${dataGuardAssociationDatabaseFreeformTags}
      dataCollectionOptions:
        isDiagnosticsEventsEnabled: ${dataGuardAssociationDataCollectionOptionsIsDiagnosticsEventsEnabled}
        isHealthMonitoringEnabled: ${dataGuardAssociationDataCollectionOptionsIsHealthMonitoringEnabled}
        isIncidentLogsEnabled: ${dataGuardAssociationDataCollectionOptionsIsIncidentLogsEnabled}
      databaseSoftwareImageId: ${testDatabaseSoftwareImage.id}
      dbSystemDefinedTags: ${dataGuardAssociationDbSystemDefinedTags}
      dbSystemFreeformTags: ${dataGuardAssociationDbSystemFreeformTags}
      dbSystemSecurityAttributes: ${dataGuardAssociationDbSystemSecurityAttributes}
      displayName: ${dataGuardAssociationDisplayName}
      domain: ${dataGuardAssociationDomain}
      faultDomains: ${dataGuardAssociationFaultDomains}
      hostname: ${dataGuardAssociationHostname}
      isActiveDataGuardEnabled: ${dataGuardAssociationIsActiveDataGuardEnabled}
      licenseModel: ${dataGuardAssociationLicenseModel}
      nodeCount: ${dataGuardAssociationNodeCount}
      nsgIds: ${dataGuardAssociationNsgIds}
      peerDbHomeId: ${testDbHome.id}
      peerDbSystemId: ${testDbSystem.id}
      peerDbUniqueName: ${dataGuardAssociationPeerDbUniqueName}
      peerSidPrefix: ${dataGuardAssociationPeerSidPrefix}
      peerVmClusterId: ${testVmCluster.id}
      privateIp: ${dataGuardAssociationPrivateIp}
      privateIpV6: ${dataGuardAssociationPrivateIpV6}
      shape: ${dataGuardAssociationShape}
      storageVolumePerformanceMode: ${dataGuardAssociationStorageVolumePerformanceMode}
      subnetId: ${testSubnet.id}
      timeZone: ${dataGuardAssociationTimeZone}

Create DataGuardAssociation Resource

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

Constructor syntax

new DataGuardAssociation(name: string, args: DataGuardAssociationArgs, opts?: CustomResourceOptions);

@overload
def DataGuardAssociation(resource_name: str,
                         args: DataGuardAssociationArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DataGuardAssociation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         database_admin_password: Optional[str] = None,
                         transport_type: Optional[str] = None,
                         protection_mode: Optional[str] = None,
                         delete_standby_db_home_on_delete: Optional[str] = None,
                         creation_type: Optional[str] = None,
                         database_id: Optional[str] = None,
                         hostname: Optional[str] = None,
                         migrate_trigger: Optional[int] = None,
                         database_freeform_tags: Optional[Mapping[str, str]] = None,
                         data_collection_options: Optional[DataGuardAssociationDataCollectionOptionsArgs] = None,
                         database_software_image_id: Optional[str] = None,
                         db_system_defined_tags: Optional[Mapping[str, str]] = None,
                         db_system_freeform_tags: Optional[Mapping[str, str]] = None,
                         db_system_security_attributes: Optional[Mapping[str, str]] = None,
                         create_async: Optional[bool] = None,
                         display_name: Optional[str] = None,
                         domain: Optional[str] = None,
                         fault_domains: Optional[Sequence[str]] = None,
                         availability_domain: Optional[str] = None,
                         is_active_data_guard_enabled: Optional[bool] = None,
                         license_model: Optional[str] = None,
                         database_defined_tags: Optional[Mapping[str, 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,
                         private_ip_v6: Optional[str] = None,
                         cpu_core_count: Optional[int] = None,
                         shape: Optional[str] = None,
                         storage_volume_performance_mode: Optional[str] = None,
                         subnet_id: Optional[str] = None,
                         time_zone: Optional[str] = None,
                         backup_network_nsg_ids: Optional[Sequence[str]] = 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.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var dataGuardAssociationResource = new Oci.Database.DataGuardAssociation("dataGuardAssociationResource", new()
{
    DatabaseAdminPassword = "string",
    TransportType = "string",
    ProtectionMode = "string",
    DeleteStandbyDbHomeOnDelete = "string",
    CreationType = "string",
    DatabaseId = "string",
    Hostname = "string",
    MigrateTrigger = 0,
    DatabaseFreeformTags = 
    {
        { "string", "string" },
    },
    DataCollectionOptions = new Oci.Database.Inputs.DataGuardAssociationDataCollectionOptionsArgs
    {
        IsDiagnosticsEventsEnabled = false,
        IsHealthMonitoringEnabled = false,
        IsIncidentLogsEnabled = false,
    },
    DatabaseSoftwareImageId = "string",
    DbSystemDefinedTags = 
    {
        { "string", "string" },
    },
    DbSystemFreeformTags = 
    {
        { "string", "string" },
    },
    DbSystemSecurityAttributes = 
    {
        { "string", "string" },
    },
    CreateAsync = false,
    DisplayName = "string",
    Domain = "string",
    FaultDomains = new[]
    {
        "string",
    },
    AvailabilityDomain = "string",
    IsActiveDataGuardEnabled = false,
    LicenseModel = "string",
    DatabaseDefinedTags = 
    {
        { "string", "string" },
    },
    NodeCount = 0,
    NsgIds = new[]
    {
        "string",
    },
    PeerDbHomeId = "string",
    PeerDbSystemId = "string",
    PeerDbUniqueName = "string",
    PeerSidPrefix = "string",
    PeerVmClusterId = "string",
    PrivateIp = "string",
    PrivateIpV6 = "string",
    CpuCoreCount = 0,
    Shape = "string",
    StorageVolumePerformanceMode = "string",
    SubnetId = "string",
    TimeZone = "string",
    BackupNetworkNsgIds = new[]
    {
        "string",
    },
});

example, err := database.NewDataGuardAssociation(ctx, "dataGuardAssociationResource", &database.DataGuardAssociationArgs{
	DatabaseAdminPassword:       pulumi.String("string"),
	TransportType:               pulumi.String("string"),
	ProtectionMode:              pulumi.String("string"),
	DeleteStandbyDbHomeOnDelete: pulumi.String("string"),
	CreationType:                pulumi.String("string"),
	DatabaseId:                  pulumi.String("string"),
	Hostname:                    pulumi.String("string"),
	MigrateTrigger:              pulumi.Int(0),
	DatabaseFreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DataCollectionOptions: &database.DataGuardAssociationDataCollectionOptionsArgs{
		IsDiagnosticsEventsEnabled: pulumi.Bool(false),
		IsHealthMonitoringEnabled:  pulumi.Bool(false),
		IsIncidentLogsEnabled:      pulumi.Bool(false),
	},
	DatabaseSoftwareImageId: pulumi.String("string"),
	DbSystemDefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DbSystemFreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DbSystemSecurityAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CreateAsync: pulumi.Bool(false),
	DisplayName: pulumi.String("string"),
	Domain:      pulumi.String("string"),
	FaultDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	AvailabilityDomain:       pulumi.String("string"),
	IsActiveDataGuardEnabled: pulumi.Bool(false),
	LicenseModel:             pulumi.String("string"),
	DatabaseDefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NodeCount: pulumi.Int(0),
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PeerDbHomeId:                 pulumi.String("string"),
	PeerDbSystemId:               pulumi.String("string"),
	PeerDbUniqueName:             pulumi.String("string"),
	PeerSidPrefix:                pulumi.String("string"),
	PeerVmClusterId:              pulumi.String("string"),
	PrivateIp:                    pulumi.String("string"),
	PrivateIpV6:                  pulumi.String("string"),
	CpuCoreCount:                 pulumi.Int(0),
	Shape:                        pulumi.String("string"),
	StorageVolumePerformanceMode: pulumi.String("string"),
	SubnetId:                     pulumi.String("string"),
	TimeZone:                     pulumi.String("string"),
	BackupNetworkNsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var dataGuardAssociationResource = new DataGuardAssociation("dataGuardAssociationResource", DataGuardAssociationArgs.builder()
    .databaseAdminPassword("string")
    .transportType("string")
    .protectionMode("string")
    .deleteStandbyDbHomeOnDelete("string")
    .creationType("string")
    .databaseId("string")
    .hostname("string")
    .migrateTrigger(0)
    .databaseFreeformTags(Map.of("string", "string"))
    .dataCollectionOptions(DataGuardAssociationDataCollectionOptionsArgs.builder()
        .isDiagnosticsEventsEnabled(false)
        .isHealthMonitoringEnabled(false)
        .isIncidentLogsEnabled(false)
        .build())
    .databaseSoftwareImageId("string")
    .dbSystemDefinedTags(Map.of("string", "string"))
    .dbSystemFreeformTags(Map.of("string", "string"))
    .dbSystemSecurityAttributes(Map.of("string", "string"))
    .createAsync(false)
    .displayName("string")
    .domain("string")
    .faultDomains("string")
    .availabilityDomain("string")
    .isActiveDataGuardEnabled(false)
    .licenseModel("string")
    .databaseDefinedTags(Map.of("string", "string"))
    .nodeCount(0)
    .nsgIds("string")
    .peerDbHomeId("string")
    .peerDbSystemId("string")
    .peerDbUniqueName("string")
    .peerSidPrefix("string")
    .peerVmClusterId("string")
    .privateIp("string")
    .privateIpV6("string")
    .cpuCoreCount(0)
    .shape("string")
    .storageVolumePerformanceMode("string")
    .subnetId("string")
    .timeZone("string")
    .backupNetworkNsgIds("string")
    .build());

data_guard_association_resource = oci.database.DataGuardAssociation("dataGuardAssociationResource",
    database_admin_password="string",
    transport_type="string",
    protection_mode="string",
    delete_standby_db_home_on_delete="string",
    creation_type="string",
    database_id="string",
    hostname="string",
    migrate_trigger=0,
    database_freeform_tags={
        "string": "string",
    },
    data_collection_options={
        "is_diagnostics_events_enabled": False,
        "is_health_monitoring_enabled": False,
        "is_incident_logs_enabled": False,
    },
    database_software_image_id="string",
    db_system_defined_tags={
        "string": "string",
    },
    db_system_freeform_tags={
        "string": "string",
    },
    db_system_security_attributes={
        "string": "string",
    },
    create_async=False,
    display_name="string",
    domain="string",
    fault_domains=["string"],
    availability_domain="string",
    is_active_data_guard_enabled=False,
    license_model="string",
    database_defined_tags={
        "string": "string",
    },
    node_count=0,
    nsg_ids=["string"],
    peer_db_home_id="string",
    peer_db_system_id="string",
    peer_db_unique_name="string",
    peer_sid_prefix="string",
    peer_vm_cluster_id="string",
    private_ip="string",
    private_ip_v6="string",
    cpu_core_count=0,
    shape="string",
    storage_volume_performance_mode="string",
    subnet_id="string",
    time_zone="string",
    backup_network_nsg_ids=["string"])

const dataGuardAssociationResource = new oci.database.DataGuardAssociation("dataGuardAssociationResource", {
    databaseAdminPassword: "string",
    transportType: "string",
    protectionMode: "string",
    deleteStandbyDbHomeOnDelete: "string",
    creationType: "string",
    databaseId: "string",
    hostname: "string",
    migrateTrigger: 0,
    databaseFreeformTags: {
        string: "string",
    },
    dataCollectionOptions: {
        isDiagnosticsEventsEnabled: false,
        isHealthMonitoringEnabled: false,
        isIncidentLogsEnabled: false,
    },
    databaseSoftwareImageId: "string",
    dbSystemDefinedTags: {
        string: "string",
    },
    dbSystemFreeformTags: {
        string: "string",
    },
    dbSystemSecurityAttributes: {
        string: "string",
    },
    createAsync: false,
    displayName: "string",
    domain: "string",
    faultDomains: ["string"],
    availabilityDomain: "string",
    isActiveDataGuardEnabled: false,
    licenseModel: "string",
    databaseDefinedTags: {
        string: "string",
    },
    nodeCount: 0,
    nsgIds: ["string"],
    peerDbHomeId: "string",
    peerDbSystemId: "string",
    peerDbUniqueName: "string",
    peerSidPrefix: "string",
    peerVmClusterId: "string",
    privateIp: "string",
    privateIpV6: "string",
    cpuCoreCount: 0,
    shape: "string",
    storageVolumePerformanceMode: "string",
    subnetId: "string",
    timeZone: "string",
    backupNetworkNsgIds: ["string"],
});

type: oci:Database:DataGuardAssociation
properties:
    availabilityDomain: string
    backupNetworkNsgIds:
        - string
    cpuCoreCount: 0
    createAsync: false
    creationType: string
    dataCollectionOptions:
        isDiagnosticsEventsEnabled: false
        isHealthMonitoringEnabled: false
        isIncidentLogsEnabled: false
    databaseAdminPassword: string
    databaseDefinedTags:
        string: string
    databaseFreeformTags:
        string: string
    databaseId: string
    databaseSoftwareImageId: string
    dbSystemDefinedTags:
        string: string
    dbSystemFreeformTags:
        string: string
    dbSystemSecurityAttributes:
        string: string
    deleteStandbyDbHomeOnDelete: string
    displayName: string
    domain: string
    faultDomains:
        - string
    hostname: string
    isActiveDataGuardEnabled: false
    licenseModel: string
    migrateTrigger: 0
    nodeCount: 0
    nsgIds:
        - string
    peerDbHomeId: string
    peerDbSystemId: string
    peerDbUniqueName: string
    peerSidPrefix: string
    peerVmClusterId: string
    privateIp: string
    privateIpV6: string
    protectionMode: string
    shape: string
    storageVolumePerformanceMode: string
    subnetId: string
    timeZone: string
    transportType: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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.

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 CPU cores available for AMD-based virtual machine DB systems.

CreateAsync bool

DataCollectionOptions DataGuardAssociationDataCollectionOptions

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

DatabaseDefinedTags Dictionary<string, string>

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

DatabaseFreeformTags Dictionary<string, string>

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

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

DbSystemFreeformTags Dictionary<string, string>

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

DbSystemSecurityAttributes Dictionary<string, string>

Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}

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.

Domain string

A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

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. Bring your own license (BYOL) allows you to select the DB edition using the optional parameter, for Autonomous Database Serverless.

MigrateTrigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

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.

PrivateIpV6 string

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

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

CpuCoreCount int

The number of CPU 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]string

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

DatabaseFreeformTags map[string]string

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

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

DbSystemFreeformTags map[string]string

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

DbSystemSecurityAttributes map[string]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.

Domain string

FaultDomains []string

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.

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

MigrateTrigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

NodeCount int

NsgIds []string

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.

PrivateIpV6 string

The IPv6 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 IPv6 address from the subnet.

Shape string

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

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.

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>

cpuCoreCount Integer

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

createAsync Boolean

dataCollectionOptions DataGuardAssociationDataCollectionOptions

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

databaseDefinedTags Map<String,String>

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

databaseFreeformTags Map<String,String>

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

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

dbSystemFreeformTags Map<String,String>

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

dbSystemSecurityAttributes Map<String,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.

domain String

faultDomains List<String>

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.

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

migrateTrigger Integer

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount Integer

nsgIds List<String>

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.

privateIpV6 String

The IPv6 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 IPv6 address from the subnet.

shape String

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

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.

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

cpuCoreCount number

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

createAsync boolean

dataCollectionOptions DataGuardAssociationDataCollectionOptions

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

databaseDefinedTags {[key: string]: string}

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

databaseFreeformTags {[key: string]: string}

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]: string}

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

dbSystemFreeformTags {[key: string]: string}

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

dbSystemSecurityAttributes {[key: string]: 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.

domain string

faultDomains string[]

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.

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

migrateTrigger number

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount number

nsgIds string[]

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.

privateIpV6 string

The IPv6 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 IPv6 address from the subnet.

shape string

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

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.

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]

cpu_core_count int

The number of CPU 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, str]

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, str]

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, str]

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, str]

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

db_system_security_attributes Mapping[str, 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.

domain str

fault_domains Sequence[str]

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.

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

migrate_trigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

node_count int

nsg_ids Sequence[str]

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.

private_ip_v6 str

The IPv6 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 IPv6 address from the subnet.

shape str

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

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.

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>

cpuCoreCount Number

The number of CPU 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<String>

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

databaseFreeformTags Map<String>

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>

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

dbSystemFreeformTags Map<String>

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

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

domain String

faultDomains List<String>

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.

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

migrateTrigger Number

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount Number

nsgIds List<String>

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.

privateIpV6 String

The IPv6 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 IPv6 address from the subnet.

shape String

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

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[DataGuardAssociationDataCollectionOptionsArgs] = None,
        database_admin_password: Optional[str] = None,
        database_defined_tags: Optional[Mapping[str, str]] = None,
        database_freeform_tags: Optional[Mapping[str, str]] = None,
        database_id: Optional[str] = None,
        database_software_image_id: Optional[str] = None,
        db_system_defined_tags: Optional[Mapping[str, str]] = None,
        db_system_freeform_tags: Optional[Mapping[str, str]] = None,
        db_system_security_attributes: Optional[Mapping[str, str]] = None,
        delete_standby_db_home_on_delete: Optional[str] = None,
        display_name: Optional[str] = None,
        domain: 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,
        migrate_trigger: Optional[int] = 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,
        private_ip_v6: 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)

resources:  _:    type: oci:Database:DataGuardAssociation    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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>

CpuCoreCount int

The number of CPU 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 DataGuardAssociationDataCollectionOptions

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

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

DatabaseFreeformTags Dictionary<string, string>

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

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

DbSystemFreeformTags Dictionary<string, string>

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

DbSystemSecurityAttributes Dictionary<string, string>

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.

Domain string

FaultDomains List<string>

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.

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

LifecycleDetails string

Additional information about the current lifecycleState, if available.

MigrateTrigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

NodeCount int

NsgIds List<string>

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.

PrivateIpV6 string

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

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

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.

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

CpuCoreCount int

The number of CPU 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]string

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

DatabaseFreeformTags map[string]string

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

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

DbSystemFreeformTags map[string]string

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

DbSystemSecurityAttributes map[string]string

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.

Domain string

FaultDomains []string

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.

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

LifecycleDetails string

Additional information about the current lifecycleState, if available.

MigrateTrigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

NodeCount int

NsgIds []string

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.

PrivateIpV6 string

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

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

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.

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>

cpuCoreCount Integer

The number of CPU 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 DataGuardAssociationDataCollectionOptions

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

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

databaseFreeformTags Map<String,String>

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

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

dbSystemFreeformTags Map<String,String>

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

dbSystemSecurityAttributes Map<String,String>

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.

domain String

faultDomains List<String>

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.

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

lifecycleDetails String

Additional information about the current lifecycleState, if available.

migrateTrigger Integer

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount Integer

nsgIds List<String>

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.

privateIpV6 String

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

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

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.

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

cpuCoreCount number

The number of CPU 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 DataGuardAssociationDataCollectionOptions

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]: string}

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

databaseFreeformTags {[key: string]: string}

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]: string}

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

dbSystemFreeformTags {[key: string]: string}

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

dbSystemSecurityAttributes {[key: string]: string}

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.

domain string

faultDomains string[]

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.

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

lifecycleDetails string

Additional information about the current lifecycleState, if available.

migrateTrigger number

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount number

nsgIds string[]

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.

privateIpV6 string

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

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

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.

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]

cpu_core_count int

The number of CPU 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, str]

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, str]

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, str]

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, str]

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

db_system_security_attributes Mapping[str, str]

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.

domain str

fault_domains Sequence[str]

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.

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

lifecycle_details str

Additional information about the current lifecycleState, if available.

migrate_trigger int

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

node_count int

nsg_ids Sequence[str]

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.

private_ip_v6 str

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

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

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.

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>

cpuCoreCount Number

The number of CPU 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<String>

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

databaseFreeformTags Map<String>

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>

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

dbSystemFreeformTags Map<String>

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

dbSystemSecurityAttributes Map<String>

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.

domain String

faultDomains List<String>

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.

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

lifecycleDetails String

Additional information about the current lifecycleState, if available.

migrateTrigger Number

(Updatable) An optional property when incremented triggers Migrate. Could be set to any integer value.

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

nodeCount Number

nsgIds List<String>

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.

privateIpV6 String

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

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

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.

Supporting Types

DataGuardAssociationDataCollectionOptions, DataGuardAssociationDataCollectionOptionsArgs

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.

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

Package Details

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

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.DataGuardAssociation

On this page

On this page

Example Usage

Create DataGuardAssociation Resource

Constructor syntax

Parameters

Constructor example

DataGuardAssociation Resource Properties

Inputs

Outputs

Look up Existing DataGuardAssociation Resource

Supporting Types

DataGuardAssociationDataCollectionOptions, DataGuardAssociationDataCollectionOptionsArgs

Import

Package Details

On this page

On this page