/** * Database Service API * The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](https://docs.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm). * OpenAPI spec version: 20160918 * Contact: sic_dbaas_cp_us_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only. * */ export interface CreateCloudVmClusterDetails { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ "compartmentId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ "subscriptionId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. * */ "subnetId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. * */ "backupSubnetId": string; /** * For fixed shapes, this is the total number of OCPUs to enable across the VM cluster. *

- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48. * - Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100. * - Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200. * - Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400. *

The API specification for fixed shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary *

* For flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. *

- Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server. * - Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server. *

For flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure. *

- Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server. *

The API specification for flexible shape values is https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "cpuCoreCount": number; /** * The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "ocpuCount"?: number; /** * The memory to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "memorySizeInGBs"?: number; /** * The local node storage to be allocated in GBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "dbNodeStorageSizeInGBs"?: number; /** * The data disk group size to be allocated in TBs. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "dataStorageSizeInTBs"?: number; /** * The list of DB servers. */ "dbServers"?: Array; /** * The cluster name for cloud VM cluster. The cluster name must begin with 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. * */ "clusterName"?: string; /** * The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "dataStoragePercentage"?: number; /** * The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "recoStoragePercentage"?: number; /** * The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "sparseStoragePercentage"?: number; /** * The user-friendly name for the cloud VM cluster. The name does not need to be unique. */ "displayName": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. */ "cloudExadataInfrastructureId": string; /** * The hostname for the cloud VM cluster. 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 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 cloud VM Cluster will fail to provision. * */ "hostname": string; /** * A domain name used for the cloud VM cluster. 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. * Applies to Exadata Cloud Service instances only. * */ "domain"?: string; /** * The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. */ "sshPublicKeys": Array; /** * The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE. * */ "licenseModel"?: CreateCloudVmClusterDetails.LicenseModel; /** * If true, the sparse disk group is configured for the cloud VM cluster. If false, the sparse disk group is not created. * */ "isSparseDiskgroupEnabled"?: boolean; /** * If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. * */ "isLocalBackupEnabled"?: boolean; /** * The time zone to use for the cloud VM cluster. For details, see [Time Zones](https://docs.oracle.com/iaas/Content/Database/References/timezones.htm). * */ "timeZone"?: string; /** * The TCP Single Client Access Name (SCAN) port. The default port is 1521. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "scanListenerPortTcp"?: number; /** * The TCPS Single Client Access Name (SCAN) port. The default port is 2484. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "scanListenerPortTcpSsl"?: number; /** * The private zone id in which DNS records need to be created. */ "privateZoneId"?: string; /** * The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). * **NsgIds restrictions:** * - A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. * */ "nsgIds"?: Array; /** * A list of the [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. * */ "backupNetworkNsgIds"?: Array; /** * A valid Oracle Grid Infrastructure (GI) software version. */ "giVersion": string; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. * For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. * For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). * Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}} * */ "securityAttributes"?: { [key: string]: { [key: string]: any; }; }; "dataCollectionOptions"?: model.DataCollectionOptions; /** * Operating system version of the image. */ "systemVersion"?: string; /** * Details of the file system configuration of the VM cluster. */ "fileSystemConfigurationDetails"?: Array; "cloudAutomationUpdateDetails"?: model.CloudAutomationUpdateDetails; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. */ "exascaleDbStorageVaultId"?: string; /** * The vmcluster type for the VM cluster/Cloud VM cluster. */ "vmClusterType"?: CreateCloudVmClusterDetails.VmClusterType; /** * Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL */ "vmFileSystemStorageType"?: CreateCloudVmClusterDetails.VmFileSystemStorageType; /** * Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL */ "vmBackupStorageType"?: CreateCloudVmClusterDetails.VmBackupStorageType; } export declare namespace CreateCloudVmClusterDetails { enum LicenseModel { LicenseIncluded = "LICENSE_INCLUDED", BringYourOwnLicense = "BRING_YOUR_OWN_LICENSE" } enum VmClusterType { Regular = "REGULAR", Developer = "DEVELOPER" } enum VmFileSystemStorageType { Local = "LOCAL", Exascale = "EXASCALE" } enum VmBackupStorageType { Local = "LOCAL", Exascale = "EXASCALE" } function getJsonObj(obj: CreateCloudVmClusterDetails): object; function getDeserializedJsonObj(obj: CreateCloudVmClusterDetails): object; }