Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Database.getDataGuardAssociations

This data source provides the list of Data Guard Associations in Oracle Cloud Infrastructure Database service.

Lists all Data Guard associations for the specified database.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testDataGuardAssociations = Oci.Database.GetDataGuardAssociations.Invoke(new()
    {
        DatabaseId = oci_database_database.Test_database.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.GetDataGuardAssociations(ctx, &database.GetDataGuardAssociationsArgs{
			DatabaseId: oci_database_database.Test_database.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetDataGuardAssociationsArgs;
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 testDataGuardAssociations = DatabaseFunctions.getDataGuardAssociations(GetDataGuardAssociationsArgs.builder()
            .databaseId(oci_database_database.test_database().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_data_guard_associations = oci.Database.get_data_guard_associations(database_id=oci_database_database["test_database"]["id"])

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

const testDataGuardAssociations = oci.Database.getDataGuardAssociations({
    databaseId: oci_database_database.test_database.id,
});

variables:
  testDataGuardAssociations:
    fn::invoke:
      Function: oci:Database:getDataGuardAssociations
      Arguments:
        databaseId: ${oci_database_database.test_database.id}

Using getDataGuardAssociations

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 getDataGuardAssociations(args: GetDataGuardAssociationsArgs, opts?: InvokeOptions): Promise<GetDataGuardAssociationsResult>
function getDataGuardAssociationsOutput(args: GetDataGuardAssociationsOutputArgs, opts?: InvokeOptions): Output<GetDataGuardAssociationsResult>

def get_data_guard_associations(database_id: Optional[str] = None,
                                filters: Optional[Sequence[_database.GetDataGuardAssociationsFilter]] = None,
                                opts: Optional[InvokeOptions] = None) -> GetDataGuardAssociationsResult
def get_data_guard_associations_output(database_id: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetDataGuardAssociationsFilterArgs]]]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetDataGuardAssociationsResult]

func GetDataGuardAssociations(ctx *Context, args *GetDataGuardAssociationsArgs, opts ...InvokeOption) (*GetDataGuardAssociationsResult, error)
func GetDataGuardAssociationsOutput(ctx *Context, args *GetDataGuardAssociationsOutputArgs, opts ...InvokeOption) GetDataGuardAssociationsResultOutput

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

public static class GetDataGuardAssociations 
{
    public static Task<GetDataGuardAssociationsResult> InvokeAsync(GetDataGuardAssociationsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataGuardAssociationsResult> Invoke(GetDataGuardAssociationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataGuardAssociationsResult> getDataGuardAssociations(GetDataGuardAssociationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

DatabaseId string: The database OCID.
Filters List<GetDataGuardAssociationsFilter>

DatabaseId string: The database OCID.
Filters []GetDataGuardAssociationsFilter

databaseId String: The database OCID.
filters List<GetDataGuardAssociationsFilter>

databaseId string: The database OCID.
filters GetDataGuardAssociationsFilter[]

database_id str: The database OCID.
filters GetDataGuardAssociationsFilter]

databaseId String: The database OCID.
filters List<Property Map>

getDataGuardAssociations Result

The following output properties are available:

DataGuardAssociations List<GetDataGuardAssociationsDataGuardAssociation>: The list of data_guard_associations.
DatabaseId string: The OCID of the reporting database.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetDataGuardAssociationsFilter>

DataGuardAssociations []GetDataGuardAssociationsDataGuardAssociation: The list of data_guard_associations.
DatabaseId string: The OCID of the reporting database.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetDataGuardAssociationsFilter

dataGuardAssociations List<GetDataGuardAssociationsDataGuardAssociation>: The list of data_guard_associations.
databaseId String: The OCID of the reporting database.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetDataGuardAssociationsFilter>

dataGuardAssociations GetDataGuardAssociationsDataGuardAssociation[]: The list of data_guard_associations.
databaseId string: The OCID of the reporting database.
id string: The provider-assigned unique ID for this managed resource.
filters GetDataGuardAssociationsFilter[]

data_guard_associations GetDataGuardAssociationsDataGuardAssociation]: The list of data_guard_associations.
database_id str: The OCID of the reporting database.
id str: The provider-assigned unique ID for this managed resource.
filters GetDataGuardAssociationsFilter]

dataGuardAssociations List<Property Map>: The list of data_guard_associations.
databaseId String: The OCID of the reporting database.
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>

Supporting Types

GetDataGuardAssociationsDataGuardAssociation

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<GetDataGuardAssociationsDataGuardAssociationDataCollectionOption>
DatabaseAdminPassword string
DatabaseDefinedTags Dictionary<string, object>
DatabaseFreeformTags Dictionary<string, object>
DatabaseId string: The database OCID.
DatabaseSoftwareImageId string
DbSystemDefinedTags Dictionary<string, object>
DbSystemFreeformTags Dictionary<string, object>
DeleteStandbyDbHomeOnDelete string
DisplayName 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.
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
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 []GetDataGuardAssociationsDataGuardAssociationDataCollectionOption
DatabaseAdminPassword string
DatabaseDefinedTags map[string]interface{}
DatabaseFreeformTags map[string]interface{}
DatabaseId string: The database OCID.
DatabaseSoftwareImageId string
DbSystemDefinedTags map[string]interface{}
DbSystemFreeformTags map[string]interface{}
DeleteStandbyDbHomeOnDelete string
DisplayName 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.
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
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<GetDataGuardAssociationsDataGuardAssociationDataCollectionOption>
databaseAdminPassword String
databaseDefinedTags Map<String,Object>
databaseFreeformTags Map<String,Object>
databaseId String: The database OCID.
databaseSoftwareImageId String
dbSystemDefinedTags Map<String,Object>
dbSystemFreeformTags Map<String,Object>
deleteStandbyDbHomeOnDelete String
displayName 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.
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
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 GetDataGuardAssociationsDataGuardAssociationDataCollectionOption[]
databaseAdminPassword string
databaseDefinedTags {[key: string]: any}
databaseFreeformTags {[key: string]: any}
databaseId string: The database OCID.
databaseSoftwareImageId string
dbSystemDefinedTags {[key: string]: any}
dbSystemFreeformTags {[key: string]: any}
deleteStandbyDbHomeOnDelete string
displayName 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.
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
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 GetDataGuardAssociationsDataGuardAssociationDataCollectionOption]
database_admin_password str
database_defined_tags Mapping[str, Any]
database_freeform_tags Mapping[str, Any]
database_id str: The database OCID.
database_software_image_id str
db_system_defined_tags Mapping[str, Any]
db_system_freeform_tags Mapping[str, Any]
delete_standby_db_home_on_delete str
display_name 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.
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
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>
databaseAdminPassword String
databaseDefinedTags Map<Any>
databaseFreeformTags Map<Any>
databaseId String: The database OCID.
databaseSoftwareImageId String
dbSystemDefinedTags Map<Any>
dbSystemFreeformTags Map<Any>
deleteStandbyDbHomeOnDelete String
displayName 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.
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
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.