Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

DataGuardAssociation

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

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

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

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDataGuardAssociation = new Oci.Database.DataGuardAssociation("testDataGuardAssociation", new Oci.Database.DataGuardAssociationArgs
        {
            CreationType = @var.Data_guard_association_creation_type,
            DatabaseAdminPassword = @var.Data_guard_association_database_admin_password,
            DatabaseId = oci_database_database.Test_database.Id,
            DeleteStandbyDbHomeOnDelete = @var.Data_guard_association_delete_standby_db_home_on_delete,
            ProtectionMode = @var.Data_guard_association_protection_mode,
            TransportType = @var.Data_guard_association_transport_type,
            AvailabilityDomain = @var.Data_guard_association_availability_domain,
            BackupNetworkNsgIds = @var.Data_guard_association_backup_network_nsg_ids,
            DatabaseSoftwareImageId = oci_database_database_software_image.Test_database_software_image.Id,
            DisplayName = @var.Data_guard_association_display_name,
            Hostname = @var.Data_guard_association_hostname,
            IsActiveDataGuardEnabled = @var.Data_guard_association_is_active_data_guard_enabled,
            NsgIds = @var.Data_guard_association_nsg_ids,
            PeerDbHomeId = oci_database_db_home.Test_db_home.Id,
            PeerDbSystemId = oci_database_db_system.Test_db_system.Id,
            PeerDbUniqueName = @var.Data_guard_association_peer_db_unique_name,
            PeerSidPrefix = @var.Data_guard_association_peer_sid_prefix,
            PeerVmClusterId = oci_database_vm_cluster.Test_vm_cluster.Id,
            Shape = @var.Data_guard_association_shape,
            SubnetId = oci_core_subnet.Test_subnet.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.NewDataGuardAssociation(ctx, "testDataGuardAssociation", &Database.DataGuardAssociationArgs{
			CreationType:                pulumi.Any(_var.Data_guard_association_creation_type),
			DatabaseAdminPassword:       pulumi.Any(_var.Data_guard_association_database_admin_password),
			DatabaseId:                  pulumi.Any(oci_database_database.Test_database.Id),
			DeleteStandbyDbHomeOnDelete: pulumi.Any(_var.Data_guard_association_delete_standby_db_home_on_delete),
			ProtectionMode:              pulumi.Any(_var.Data_guard_association_protection_mode),
			TransportType:               pulumi.Any(_var.Data_guard_association_transport_type),
			AvailabilityDomain:          pulumi.Any(_var.Data_guard_association_availability_domain),
			BackupNetworkNsgIds:         pulumi.Any(_var.Data_guard_association_backup_network_nsg_ids),
			DatabaseSoftwareImageId:     pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
			DisplayName:                 pulumi.Any(_var.Data_guard_association_display_name),
			Hostname:                    pulumi.Any(_var.Data_guard_association_hostname),
			IsActiveDataGuardEnabled:    pulumi.Any(_var.Data_guard_association_is_active_data_guard_enabled),
			NsgIds:                      pulumi.Any(_var.Data_guard_association_nsg_ids),
			PeerDbHomeId:                pulumi.Any(oci_database_db_home.Test_db_home.Id),
			PeerDbSystemId:              pulumi.Any(oci_database_db_system.Test_db_system.Id),
			PeerDbUniqueName:            pulumi.Any(_var.Data_guard_association_peer_db_unique_name),
			PeerSidPrefix:               pulumi.Any(_var.Data_guard_association_peer_sid_prefix),
			PeerVmClusterId:             pulumi.Any(oci_database_vm_cluster.Test_vm_cluster.Id),
			Shape:                       pulumi.Any(_var.Data_guard_association_shape),
			SubnetId:                    pulumi.Any(oci_core_subnet.Test_subnet.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_data_guard_association = oci.database.DataGuardAssociation("testDataGuardAssociation",
    creation_type=var["data_guard_association_creation_type"],
    database_admin_password=var["data_guard_association_database_admin_password"],
    database_id=oci_database_database["test_database"]["id"],
    delete_standby_db_home_on_delete=var["data_guard_association_delete_standby_db_home_on_delete"],
    protection_mode=var["data_guard_association_protection_mode"],
    transport_type=var["data_guard_association_transport_type"],
    availability_domain=var["data_guard_association_availability_domain"],
    backup_network_nsg_ids=var["data_guard_association_backup_network_nsg_ids"],
    database_software_image_id=oci_database_database_software_image["test_database_software_image"]["id"],
    display_name=var["data_guard_association_display_name"],
    hostname=var["data_guard_association_hostname"],
    is_active_data_guard_enabled=var["data_guard_association_is_active_data_guard_enabled"],
    nsg_ids=var["data_guard_association_nsg_ids"],
    peer_db_home_id=oci_database_db_home["test_db_home"]["id"],
    peer_db_system_id=oci_database_db_system["test_db_system"]["id"],
    peer_db_unique_name=var["data_guard_association_peer_db_unique_name"],
    peer_sid_prefix=var["data_guard_association_peer_sid_prefix"],
    peer_vm_cluster_id=oci_database_vm_cluster["test_vm_cluster"]["id"],
    shape=var["data_guard_association_shape"],
    subnet_id=oci_core_subnet["test_subnet"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataGuardAssociation = new oci.database.DataGuardAssociation("testDataGuardAssociation", {
    creationType: _var.data_guard_association_creation_type,
    databaseAdminPassword: _var.data_guard_association_database_admin_password,
    databaseId: oci_database_database.test_database.id,
    deleteStandbyDbHomeOnDelete: _var.data_guard_association_delete_standby_db_home_on_delete,
    protectionMode: _var.data_guard_association_protection_mode,
    transportType: _var.data_guard_association_transport_type,
    availabilityDomain: _var.data_guard_association_availability_domain,
    backupNetworkNsgIds: _var.data_guard_association_backup_network_nsg_ids,
    databaseSoftwareImageId: oci_database_database_software_image.test_database_software_image.id,
    displayName: _var.data_guard_association_display_name,
    hostname: _var.data_guard_association_hostname,
    isActiveDataGuardEnabled: _var.data_guard_association_is_active_data_guard_enabled,
    nsgIds: _var.data_guard_association_nsg_ids,
    peerDbHomeId: oci_database_db_home.test_db_home.id,
    peerDbSystemId: oci_database_db_system.test_db_system.id,
    peerDbUniqueName: _var.data_guard_association_peer_db_unique_name,
    peerSidPrefix: _var.data_guard_association_peer_sid_prefix,
    peerVmClusterId: oci_database_vm_cluster.test_vm_cluster.id,
    shape: _var.data_guard_association_shape,
    subnetId: oci_core_subnet.test_subnet.id,
});

Coming soon!

Create a DataGuardAssociation Resource

new DataGuardAssociation(name: string, args: DataGuardAssociationArgs, opts?: CustomResourceOptions);
@overload
def DataGuardAssociation(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         availability_domain: Optional[str] = None,
                         backup_network_nsg_ids: Optional[Sequence[str]] = None,
                         create_async: Optional[bool] = None,
                         creation_type: Optional[str] = None,
                         database_admin_password: Optional[str] = None,
                         database_id: Optional[str] = None,
                         database_software_image_id: Optional[str] = None,
                         delete_standby_db_home_on_delete: Optional[str] = None,
                         display_name: Optional[str] = None,
                         hostname: Optional[str] = None,
                         is_active_data_guard_enabled: Optional[bool] = 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,
                         protection_mode: Optional[str] = None,
                         shape: Optional[str] = None,
                         subnet_id: Optional[str] = None,
                         transport_type: Optional[str] = None)
@overload
def DataGuardAssociation(resource_name: str,
                         args: DataGuardAssociationArgs,
                         opts: Optional[ResourceOptions] = None)
func NewDataGuardAssociation(ctx *Context, name string, args DataGuardAssociationArgs, opts ...ResourceOption) (*DataGuardAssociation, error)
public DataGuardAssociation(string name, DataGuardAssociationArgs args, CustomResourceOptions? opts = null)
public DataGuardAssociation(String name, DataGuardAssociationArgs args)
public DataGuardAssociation(String name, DataGuardAssociationArgs args, CustomResourceOptions options)
type: oci:Database:DataGuardAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

DataGuardAssociation Resource Properties

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

Inputs

The DataGuardAssociation resource accepts the following input properties:

CreationType string

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

DatabaseAdminPassword string

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

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.

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

CreateAsync bool
DatabaseSoftwareImageId string

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

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.

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

NsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

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

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.

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

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

BackupNetworkNsgIds []string

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

CreateAsync bool
DatabaseSoftwareImageId string

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

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.

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

NsgIds []string

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

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

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.

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

createAsync Boolean
databaseSoftwareImageId String

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

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.

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

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

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.

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

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

backupNetworkNsgIds string[]

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

createAsync boolean
databaseSoftwareImageId string

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

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.

hostname string

The hostname for the DB node.

isActiveDataGuardEnabled boolean

(Updatable) True if active Data Guard is enabled.

nsgIds string[]

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

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

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.

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
availability_domain str

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

backup_network_nsg_ids Sequence[str]

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

create_async bool
database_software_image_id str

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

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.

hostname str

The hostname for the DB node.

is_active_data_guard_enabled bool

(Updatable) True if active Data Guard is enabled.

nsg_ids Sequence[str]

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

shape str

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

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

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.

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

createAsync Boolean
databaseSoftwareImageId String

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

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.

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

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

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 an 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,
        create_async: Optional[bool] = None,
        creation_type: Optional[str] = None,
        database_admin_password: Optional[str] = None,
        database_id: Optional[str] = None,
        database_software_image_id: Optional[str] = None,
        delete_standby_db_home_on_delete: Optional[str] = None,
        display_name: Optional[str] = None,
        hostname: Optional[str] = None,
        is_active_data_guard_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = 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,
        protection_mode: Optional[str] = None,
        role: Optional[str] = None,
        shape: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        time_created: Optional[str] = None,
        transport_type: Optional[str] = None) -> DataGuardAssociation
func GetDataGuardAssociation(ctx *Context, name string, id IDInput, state *DataGuardAssociationState, opts ...ResourceOption) (*DataGuardAssociation, error)
public static DataGuardAssociation Get(string name, Input<string> id, DataGuardAssociationState? state, CustomResourceOptions? opts = null)
public static DataGuardAssociation get(String name, Output<String> id, DataGuardAssociationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApplyLag string

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

ApplyRate string

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

AvailabilityDomain string

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

BackupNetworkNsgIds List<string>

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

CreateAsync bool
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.

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.

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.

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

NsgIds List<string>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

Role string

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

Shape string

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

State string

The current state of the Data Guard association.

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.

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

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

ApplyRate string

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

AvailabilityDomain string

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

BackupNetworkNsgIds []string

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

CreateAsync bool
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.

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.

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.

Hostname string

The hostname for the DB node.

IsActiveDataGuardEnabled bool

(Updatable) True if active Data Guard is enabled.

LifecycleDetails string

Additional information about the current lifecycleState, if available.

NsgIds []string

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

Role string

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

Shape string

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

State string

The current state of the Data Guard association.

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.

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

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

applyRate String

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

availabilityDomain String

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

backupNetworkNsgIds List<String>

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

createAsync Boolean
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.

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.

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.

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

role String

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

shape String

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

state String

The current state of the Data Guard association.

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.

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

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

applyRate string

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

availabilityDomain string

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

backupNetworkNsgIds string[]

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

createAsync boolean
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.

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.

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.

hostname string

The hostname for the DB node.

isActiveDataGuardEnabled boolean

(Updatable) True if active Data Guard is enabled.

lifecycleDetails string

Additional information about the current lifecycleState, if available.

nsgIds string[]

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

role string

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

shape string

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

state string

The current state of the Data Guard association.

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.

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
apply_lag str

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

apply_rate str

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

availability_domain str

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

backup_network_nsg_ids Sequence[str]

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

create_async bool
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.

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.

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.

hostname str

The hostname for the DB node.

is_active_data_guard_enabled bool

(Updatable) True if active Data Guard is enabled.

lifecycle_details str

Additional information about the current lifecycleState, if available.

nsg_ids Sequence[str]

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

role str

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

shape str

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

state str

The current state of the Data Guard association.

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.

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

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

applyRate String

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

availabilityDomain String

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

backupNetworkNsgIds List<String>

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

createAsync Boolean
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.

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.

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.

hostname String

The hostname for the DB node.

isActiveDataGuardEnabled Boolean

(Updatable) True if active Data Guard is enabled.

lifecycleDetails String

Additional information about the current lifecycleState, if available.

nsgIds List<String>

A list of the OCIDs of the network security groups (NSGs) that this resource 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. NsgIds restrictions:

  • Autonomous Databases with private access require at least 1 Network Security Group (NSG). The nsgIds array cannot 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.

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.

role String

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

shape String

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

state String

The current state of the Data Guard association.

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.

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

Import

Import is not supported for this resource.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.