oci.Database.getDataGuardAssociation

Explore with Pulumi AI

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

Example Usage

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

const testDataGuardAssociation = oci.Database.getDataGuardAssociation({
    dataGuardAssociationId: testDataGuardAssociationOciDatabaseDataGuardAssociation.id,
    databaseId: testDatabase.id,
});

import pulumi
import pulumi_oci as oci

test_data_guard_association = oci.Database.get_data_guard_association(data_guard_association_id=test_data_guard_association_oci_database_data_guard_association["id"],
    database_id=test_database["id"])

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.GetDataGuardAssociation(ctx, &database.GetDataGuardAssociationArgs{
			DataGuardAssociationId: testDataGuardAssociationOciDatabaseDataGuardAssociation.Id,
			DatabaseId:             testDatabase.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDataGuardAssociation = Oci.Database.GetDataGuardAssociation.Invoke(new()
    {
        DataGuardAssociationId = testDataGuardAssociationOciDatabaseDataGuardAssociation.Id,
        DatabaseId = testDatabase.Id,
    });

});

package generated_program;

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

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

    public static void stack(Context ctx) {
        final var testDataGuardAssociation = DatabaseFunctions.getDataGuardAssociation(GetDataGuardAssociationArgs.builder()
            .dataGuardAssociationId(testDataGuardAssociationOciDatabaseDataGuardAssociation.id())
            .databaseId(testDatabase.id())
            .build());

    }
}

variables:
  testDataGuardAssociation:
    fn::invoke:
      function: oci:Database:getDataGuardAssociation
      arguments:
        dataGuardAssociationId: ${testDataGuardAssociationOciDatabaseDataGuardAssociation.id}
        databaseId: ${testDatabase.id}

Using getDataGuardAssociation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataGuardAssociation(args: GetDataGuardAssociationArgs, opts?: InvokeOptions): Promise<GetDataGuardAssociationResult>
function getDataGuardAssociationOutput(args: GetDataGuardAssociationOutputArgs, opts?: InvokeOptions): Output<GetDataGuardAssociationResult>

def get_data_guard_association(data_guard_association_id: Optional[str] = None,
                               database_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDataGuardAssociationResult
def get_data_guard_association_output(data_guard_association_id: Optional[pulumi.Input[str]] = None,
                               database_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDataGuardAssociationResult]

func LookupDataGuardAssociation(ctx *Context, args *LookupDataGuardAssociationArgs, opts ...InvokeOption) (*LookupDataGuardAssociationResult, error)
func LookupDataGuardAssociationOutput(ctx *Context, args *LookupDataGuardAssociationOutputArgs, opts ...InvokeOption) LookupDataGuardAssociationResultOutput

> Note: This function is named LookupDataGuardAssociation in the Go SDK.

public static class GetDataGuardAssociation 
{
    public static Task<GetDataGuardAssociationResult> InvokeAsync(GetDataGuardAssociationArgs args, InvokeOptions? opts = null)
    public static Output<GetDataGuardAssociationResult> Invoke(GetDataGuardAssociationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataGuardAssociationResult> getDataGuardAssociation(GetDataGuardAssociationArgs args, InvokeOptions options)
public static Output<GetDataGuardAssociationResult> getDataGuardAssociation(GetDataGuardAssociationArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Database/getDataGuardAssociation:getDataGuardAssociation
  arguments:
    # arguments dictionary

The following arguments are supported:

DataGuardAssociationId string: The Data Guard association's OCID.
DatabaseId string: The database OCID.

DataGuardAssociationId string: The Data Guard association's OCID.
DatabaseId string: The database OCID.

dataGuardAssociationId String: The Data Guard association's OCID.
databaseId String: The database OCID.

dataGuardAssociationId string: The Data Guard association's OCID.
databaseId string: The database OCID.

data_guard_association_id str: The Data Guard association's OCID.
database_id str: The database OCID.

dataGuardAssociationId String: The Data Guard association's OCID.
databaseId String: The database OCID.

getDataGuardAssociation Result

The following output properties are available:

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
BackupNetworkNsgIds List<string>
CpuCoreCount int
CreateAsync bool
CreationType string
DataCollectionOptions List<GetDataGuardAssociationDataCollectionOption>
DataGuardAssociationId string
DatabaseAdminPassword string
DatabaseDefinedTags Dictionary<string, string>
DatabaseFreeformTags Dictionary<string, string>
DatabaseId string: The OCID of the reporting database.
DatabaseSoftwareImageId string
DbSystemDefinedTags Dictionary<string, string>
DbSystemFreeformTags Dictionary<string, string>
DbSystemSecurityAttributes Dictionary<string, string>
DeleteStandbyDbHomeOnDelete string
DisplayName string
Domain string
FaultDomains List<string>
Hostname string
Id string: The OCID of the Data Guard association.
IsActiveDataGuardEnabled bool: True if active Data Guard is enabled.
LicenseModel string
LifecycleDetails string: Additional information about the current lifecycleState, if available.
MigrateTrigger int
NodeCount int
NsgIds List<string>
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 Database Home containing the associated peer database.
PeerDbSystemId string: The OCID of the DB system containing the associated peer database.
PeerDbUniqueName string
PeerRole string: The role of the peer database in this Data Guard association.
PeerSidPrefix string
PeerVmClusterId string
PrivateIp string
PrivateIpV6 string
ProtectionMode string: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
Role string: The role of the reporting database in this Data Guard association.
Shape string
State string: The current state of the Data Guard association.
StorageVolumePerformanceMode string
SubnetId string
TimeCreated string: The date and time the Data Guard association was created.
TimeZone string
TransportType string: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

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
BackupNetworkNsgIds []string
CpuCoreCount int
CreateAsync bool
CreationType string
DataCollectionOptions []GetDataGuardAssociationDataCollectionOption
DataGuardAssociationId string
DatabaseAdminPassword string
DatabaseDefinedTags map[string]string
DatabaseFreeformTags map[string]string
DatabaseId string: The OCID of the reporting database.
DatabaseSoftwareImageId string
DbSystemDefinedTags map[string]string
DbSystemFreeformTags map[string]string
DbSystemSecurityAttributes map[string]string
DeleteStandbyDbHomeOnDelete string
DisplayName string
Domain string
FaultDomains []string
Hostname string
Id string: The OCID of the Data Guard association.
IsActiveDataGuardEnabled bool: True if active Data Guard is enabled.
LicenseModel string
LifecycleDetails string: Additional information about the current lifecycleState, if available.
MigrateTrigger int
NodeCount int
NsgIds []string
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 Database Home containing the associated peer database.
PeerDbSystemId string: The OCID of the DB system containing the associated peer database.
PeerDbUniqueName string
PeerRole string: The role of the peer database in this Data Guard association.
PeerSidPrefix string
PeerVmClusterId string
PrivateIp string
PrivateIpV6 string
ProtectionMode string: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
Role string: The role of the reporting database in this Data Guard association.
Shape string
State string: The current state of the Data Guard association.
StorageVolumePerformanceMode string
SubnetId string
TimeCreated string: The date and time the Data Guard association was created.
TimeZone string
TransportType string: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

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
backupNetworkNsgIds List<String>
cpuCoreCount Integer
createAsync Boolean
creationType String
dataCollectionOptions List<GetDataGuardAssociationDataCollectionOption>
dataGuardAssociationId String
databaseAdminPassword String
databaseDefinedTags Map<String,String>
databaseFreeformTags Map<String,String>
databaseId String: The OCID of the reporting database.
databaseSoftwareImageId String
dbSystemDefinedTags Map<String,String>
dbSystemFreeformTags Map<String,String>
dbSystemSecurityAttributes Map<String,String>
deleteStandbyDbHomeOnDelete String
displayName String
domain String
faultDomains List<String>
hostname String
id String: The OCID of the Data Guard association.
isActiveDataGuardEnabled Boolean: True if active Data Guard is enabled.
licenseModel String
lifecycleDetails String: Additional information about the current lifecycleState, if available.
migrateTrigger Integer
nodeCount Integer
nsgIds List<String>
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 Database Home containing the associated peer database.
peerDbSystemId String: The OCID of the DB system containing the associated peer database.
peerDbUniqueName String
peerRole String: The role of the peer database in this Data Guard association.
peerSidPrefix String
peerVmClusterId String
privateIp String
privateIpV6 String
protectionMode String: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
role String: The role of the reporting database in this Data Guard association.
shape String
state String: The current state of the Data Guard association.
storageVolumePerformanceMode String
subnetId String
timeCreated String: The date and time the Data Guard association was created.
timeZone String
transportType String: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

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
backupNetworkNsgIds string[]
cpuCoreCount number
createAsync boolean
creationType string
dataCollectionOptions GetDataGuardAssociationDataCollectionOption[]
dataGuardAssociationId string
databaseAdminPassword string
databaseDefinedTags {[key: string]: string}
databaseFreeformTags {[key: string]: string}
databaseId string: The OCID of the reporting database.
databaseSoftwareImageId string
dbSystemDefinedTags {[key: string]: string}
dbSystemFreeformTags {[key: string]: string}
dbSystemSecurityAttributes {[key: string]: string}
deleteStandbyDbHomeOnDelete string
displayName string
domain string
faultDomains string[]
hostname string
id string: The OCID of the Data Guard association.
isActiveDataGuardEnabled boolean: True if active Data Guard is enabled.
licenseModel string
lifecycleDetails string: Additional information about the current lifecycleState, if available.
migrateTrigger number
nodeCount number
nsgIds string[]
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 Database Home containing the associated peer database.
peerDbSystemId string: The OCID of the DB system containing the associated peer database.
peerDbUniqueName string
peerRole string: The role of the peer database in this Data Guard association.
peerSidPrefix string
peerVmClusterId string
privateIp string
privateIpV6 string
protectionMode string: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
role string: The role of the reporting database in this Data Guard association.
shape string
state string: The current state of the Data Guard association.
storageVolumePerformanceMode string
subnetId string
timeCreated string: The date and time the Data Guard association was created.
timeZone string
transportType string: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

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
backup_network_nsg_ids Sequence[str]
cpu_core_count int
create_async bool
creation_type str
data_collection_options Sequence[GetDataGuardAssociationDataCollectionOption]
data_guard_association_id str
database_admin_password str
database_defined_tags Mapping[str, str]
database_freeform_tags Mapping[str, str]
database_id str: The OCID of the reporting database.
database_software_image_id str
db_system_defined_tags Mapping[str, str]
db_system_freeform_tags Mapping[str, str]
db_system_security_attributes Mapping[str, str]
delete_standby_db_home_on_delete str
display_name str
domain str
fault_domains Sequence[str]
hostname str
id str: The OCID of the Data Guard association.
is_active_data_guard_enabled bool: True if active Data Guard is enabled.
license_model str
lifecycle_details str: Additional information about the current lifecycleState, if available.
migrate_trigger int
node_count int
nsg_ids Sequence[str]
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 Database Home containing the associated peer database.
peer_db_system_id str: The OCID of the DB system containing the associated peer database.
peer_db_unique_name str
peer_role str: The role of the peer database in this Data Guard association.
peer_sid_prefix str
peer_vm_cluster_id str
private_ip str
private_ip_v6 str
protection_mode str: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
role str: The role of the reporting database in this Data Guard association.
shape str
state str: The current state of the Data Guard association.
storage_volume_performance_mode str
subnet_id str
time_created str: The date and time the Data Guard association was created.
time_zone str
transport_type str: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.

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
backupNetworkNsgIds List<String>
cpuCoreCount Number
createAsync Boolean
creationType String
dataCollectionOptions List<Property Map>
dataGuardAssociationId String
databaseAdminPassword String
databaseDefinedTags Map<String>
databaseFreeformTags Map<String>
databaseId String: The OCID of the reporting database.
databaseSoftwareImageId String
dbSystemDefinedTags Map<String>
dbSystemFreeformTags Map<String>
dbSystemSecurityAttributes Map<String>
deleteStandbyDbHomeOnDelete String
displayName String
domain String
faultDomains List<String>
hostname String
id String: The OCID of the Data Guard association.
isActiveDataGuardEnabled Boolean: True if active Data Guard is enabled.
licenseModel String
lifecycleDetails String: Additional information about the current lifecycleState, if available.
migrateTrigger Number
nodeCount Number
nsgIds List<String>
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 Database Home containing the associated peer database.
peerDbSystemId String: The OCID of the DB system containing the associated peer database.
peerDbUniqueName String
peerRole String: The role of the peer database in this Data Guard association.
peerSidPrefix String
peerVmClusterId String
privateIp String
privateIpV6 String
protectionMode String: The protection mode of this Data Guard association. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.
role String: The role of the reporting database in this Data Guard association.
shape String
state String: The current state of the Data Guard association.
storageVolumePerformanceMode String
subnetId String
timeCreated String: The date and time the Data Guard association was created.
timeZone String
transportType String: The redo transport type used by this Data Guard association. For more information, see Redo Transport Services in the Oracle Data Guard documentation.