Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateDataGuardAssociationWithNewDbSystemDetails

The configuration details for creating a Data Guard association for a virtual machine DB system database. For this type of DB system database, the {@code creationType} should be {@code NewDbSystem}. A new DB system will be launched to create the standby database.

To create a Data Guard association for a database in a bare metal or Exadata DB system, use the {@link #createDataGuardAssociationToExistingDbSystemDetails(CreateDataGuardAssociationToExistingDbSystemDetailsRequest) createDataGuardAssociationToExistingDbSystemDetails} subtype instead.

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

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

Optional backupNetworkNsgIds

backupNetworkNsgIds: Array<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.

Optional cpuCoreCount

cpuCoreCount: undefined | number

The number of CPU cores available for AMD-based virtual machine DB systems. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Const creationType

creationType: string = "NewDbSystem"

Optional dataCollectionOptions

dataCollectionOptions: model.DataCollectionOptions

databaseAdminPassword

databaseAdminPassword: string

A strong password for the {@code SYS}, {@code SYSTEM}, and {@code PDB Admin} users to apply during standby creation.

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

At least two uppercase characters.

At least two lowercase characters.

At least two numeric characters.

At least two special characters. Valid special characters include \"_\", \"#\", and \"-\" only.

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

Optional databaseDefinedTags

databaseDefinedTags: undefined | object

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

Optional databaseFreeformTags

databaseFreeformTags: undefined | object

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

Example: {@code {\"Department\": \"Finance\"}}

Optional databaseSoftwareImageId

databaseSoftwareImageId: undefined | string

The database software image OCID

Optional dbSystemDefinedTags

dbSystemDefinedTags: undefined | object

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

Optional dbSystemFreeformTags

dbSystemFreeformTags: undefined | object

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

Example: {@code {\"Department\": \"Finance\"}}

Optional displayName

displayName: undefined | 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.

Optional faultDomains

faultDomains: Array<string>

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

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

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

To get a list of Fault Domains, use the {@link #listFaultDomains(ListFaultDomainsRequest) listFaultDomains} operation in the Identity and Access Management Service API.

Example: {@code FAULT-DOMAIN-1}

Optional hostname

hostname: undefined | string

The hostname for the DB node.

Optional isActiveDataGuardEnabled

isActiveDataGuardEnabled: undefined | false | true

True if active Data Guard is enabled.

Optional licenseModel

licenseModel: LicenseModel

The Oracle license model that applies to all the databases on the dataguard standby DB system. The default is LICENSE_INCLUDED. Bring your own license (BYOL) allows you to select the DB edition using the optional parameter, for Autonomous Database Serverless.

Optional nodeCount

nodeCount: undefined | number

The number of nodes to launch for the DB system of the standby in the Data Guard association. For a 2-node RAC virtual machine DB system, specify either 1 or 2. If you do not supply this parameter, the default is the node count of the primary DB system. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nsgIds

nsgIds: Array<string>

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

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

Optional peerDbUniqueName

peerDbUniqueName: undefined | string

Specifies the {@code DB_UNIQUE_NAME} of the peer database to be created.

Optional peerSidPrefix

peerSidPrefix: undefined | string

Specifies a prefix for the {@code Oracle SID} of the database to be created.

Optional privateIp

privateIp: undefined | string

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

protectionMode

protectionMode: ProtectionMode

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

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

Optional shape

shape: undefined | string

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

To get a list of all shapes, use the {@link #listDbSystemShapes(ListDbSystemShapesRequest) listDbSystemShapes} operation.

Optional storageVolumePerformanceMode

storageVolumePerformanceMode: StorageVolumePerformanceMode

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

Optional subnetId

subnetId: undefined | string

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

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

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

Optional timeZone

timeZone: undefined | string

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

transportType

transportType: TransportType

The redo transport type to use for this Data Guard association. Valid values depend on the specified {@code protectionMode}:

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

For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation.

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

Methods

getDeserializedJsonObj

getJsonObj