DB Cloud Appendix

Properties File Format

The properties file is closely based on the Oracle REST Services. If you need more information than is found in this guide, please see the Oracle documentation.

The format of the properties file is as follows:

Property Name	Required	Description
version	No	Oracle Database version for the service instance
level	No	Service level for the service instance. `PAAS` or `BASIC` (Defaults to `PAAS`)
edition	No	Oracle Database edition for the service instance. (`SE, EE, EE_HP, EE_DP`)
subscription	No	A string containing the billing frequency for the service instance, either `MONTHLY` or `HOURLY`
description	No	Description of the service instance
shape	Yes	The Oracle Compute Cloud shape for the service instance, to be created. (`oc3, oc4, oc5, oc6, oc7, oc1m, oc2m, oc3m, oc4m, oc5m`)
vmPublicKeyText	Yes	The text of an SSH public key for the VM. This key is added to Oracle Compute Cloud Service as part of the instance creation operation. This should be a String starting with `ssh-rsa`.
parameter.usableStorage	No	The number of GB of usable data storage for the Oracle Database server. Include this parameter only if level is "`PAAS`"
parameter.adminPassword	No	The administration password for the service instance. Include this parameter only if level is "`PAAS`"
parameter.sid	No	The SID for the database instance. Include this parameter only if level is "`PAAS`"
parameter.pdb	No	The name for the default PDB (pluggable database). Include this parameter only if level is "`PAAS`"
parameter.backup Destination	No	The backup configuration for the service instance. Include this parameter only if level is "`PAAS`". (`BOTH, DISK, NONE`)
parameter.cloudStorage Container	No	Oracle Storage Cloud container for backups. Include this parameter only if level is "`PAAS`". Defaults to `FDDB_CLOUD_INSTANCE_NAME + "BK"` . The container is automatically created if it doesn't already exist in the Storage Cloud.
parameter.cloudStorage User	No	The username of an Oracle Cloud user with read/write access to the specified parameter.cloudStorageContainer. Include this parameter only if level is "`PAAS`" and the parameter.backupDestination is "`BOTH`"
parameter.cloudStoragePwd	No	The password for parameter.cloudStorageUser. Include this parameter only if level is "`PAAS`"

This plugin is designed to accommodate changes in Oracle’s REST API. It will pass all properties that don’t start with parameter. as top-level data in the JSON request and pass each parameter. data as data inside the parameters section. Any properties that Oracle supports can be used even if not listed in the table above. If there is a validation error, the error message can be used to troubleshoot.

Here is an example error message from leaving a field blank:

SEVERE - flexagon.ff.common.core.exceptions.FlexCheckedException.init() - FDDBCloud-00201: The value of the [shape] parameter cannot be empty.

This means that you need to send in shape={something}

If you set it to an invalid value, you will receive an error like this:

SEVERE - flexagon.ff.common.core.exceptions.FlexCheckedException.init() - FDSC-00051: Unexpected status code 503 - Service Unavailable

See https://docs.oracle.com/cloud/latest/dbcs_dbaas/CSDBI/GUID-9ECC81E2-7356-4E2C-91A9-315D7E42C203.htm#CSDBI-GUID-9ECC81E2-7356-4E2C-91A9-315D7E42C203 for more information about Oracle’s API.