Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateDbSystemDetails

Details required to create a DB System.

Properties

Optional adminPassword

adminPassword: undefined | string

The password for the administrative user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

Optional adminUsername

adminUsername: undefined | string

The username for the administrative user.

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

Optional backupPolicy

backupPolicy: model.CreateBackupPolicyDetails

compartmentId

compartmentId: string

The OCID of the compartment.

Optional configurationId

configurationId: undefined | string

The OCID of the Configuration to be used for this DB System.

Optional crashRecovery

crashRecovery: model.CrashRecoveryStatus

Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Optional dataStorageSizeInGBs

dataStorageSizeInGBs: undefined | number

Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional databaseManagement

databaseManagement: model.DatabaseManagementStatus

Whether to enable monitoring via the Database Management service.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional deletionPolicy

deletionPolicy: model.CreateDeletionPolicyDetails

Optional description

description: undefined | string

User-provided data about the DB System.

Optional displayName

displayName: undefined | string

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

Optional faultDomain

faultDomain: undefined | string

The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the fault domain in which the DB System is placed.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional hostnameLabel

hostnameLabel: undefined | string

The hostname for the primary endpoint of the DB System. Used for DNS.

The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \"dbsystem-1\" in FQDN \"dbsystem-1.subnet123.vcn1.oraclevcn.com\").

Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Optional ipAddress

ipAddress: undefined | string

The IP address the DB System is configured to listen on. A private IP address of your choice to assign to the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This should be a "dotted-quad" style IPv4 address.

Optional isHighlyAvailable

isHighlyAvailable: undefined | false | true

Specifies if the DB System is highly available.

When creating a DB System with High Availability, three instances are created and placed according to your region- and subnet-type. The secondaries are placed automatically in the other two availability or fault domains. You can choose the preferred location of your primary instance, only.

Optional maintenance

maintenance: model.CreateMaintenanceDetails

Optional mysqlVersion

mysqlVersion: undefined | string

The specific MySQL version identifier.

Optional port

port: undefined | number

The port for primary endpoint of the DB System to listen on. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional portX

portX: undefined | number

The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional secureConnections

secureConnections: model.SecureConnectionDetails

shapeName

shapeName: string

The name of the shape. The shape determines the resources allocated

  • CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the {@link #listShapes(ListShapesRequest) listShapes} operation.

Optional source

subnetId

subnetId: string

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

Functions

getDeserializedJsonObj

getJsonObj