Options
All
  • Public
  • Public/Protected
  • All
Menu

Module LaunchDbSystemDetails

Used for creating a new DB system. Does not use backups or an existing database for the creation of the initial database.

Properties

availabilityDomain

availabilityDomain: string

The availability domain where the DB system is located.

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

Optional backupSubnetId

backupSubnetId: undefined | string

The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

*Subnet Restrictions:** See the subnet restrictions information for **subnetId**.

Optional clusterName

clusterName: undefined | string

The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

compartmentId

compartmentId: string

The OCID of the compartment the DB system belongs in.

cpuCoreCount

cpuCoreCount: number

The number of CPU cores to enable for a bare metal or Exadata DB system. The valid values depend on the specified shape:

- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36. - BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52. - Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. - Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84. - Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168. - Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336. - Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92. - Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184. - Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.

This parameter is not used for virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see [Virtual Machine DB Systems](https://docs.cloud.oracle.com/Content/Database/Concepts/overview.htm#virtualmachine)

Optional dataStoragePercentage

dataStoragePercentage: undefined | number

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

databaseEdition

databaseEdition: DatabaseEdition

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

dbHome

Optional dbSystemOptions

dbSystemOptions: model.DbSystemOptions

Optional definedTags

definedTags: undefined | object

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

Optional diskRedundancy

diskRedundancy: DiskRedundancy

The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

Optional displayName

displayName: undefined | string

The user-friendly name for the DB system. The name does not have to be unique.

Optional domain

domain: undefined | string

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

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: `FAULT-DOMAIN-1`

Optional freeformTags

freeformTags: 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: `{\"Department\": \"Finance\"}`

hostname

hostname: string

The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.

The maximum length of the combined hostname and domain is 63 characters.

*Note:** The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

Optional initialDataStorageSizeInGB

initialDataStorageSizeInGB: undefined | number

Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume.

Optional licenseModel

licenseModel: LicenseModel

The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Optional maintenanceWindowDetails

maintenanceWindowDetails: model.MaintenanceWindow

Optional nodeCount

nodeCount: undefined | number

The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

Optional nsgIds

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

shape

shape: string

The shape of the DB system. The shape determines resources allocated to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

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

Const source

source: string = "NONE"

Optional sparseDiskgroup

sparseDiskgroup: undefined | false | true

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.

sshPublicKeys

sshPublicKeys: Array<string>

The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

subnetId

subnetId: string

The OCID of the subnet the DB system is associated with.

*Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

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 the backup subnet.

Optional timeZone

timeZone: undefined | string

The time zone to use for the DB system. For details, see DB System Time Zones.

Methods

getJsonObj