Basic parameters
-
List of parameters
Parameter Description Type Mandatory Constraints/default value Remarks Flavor List ID of the predefined hardware resource String Y Specifies the flavor ID.
The flavor ID
can be retrieved by using the get flavor list (GET /v1.0/{tenantId}/flavors) and get flavor information (GET /v1.0/{tenantId}/flavors/{flavorId}) APIs
Size Size of the data volume Integer Y 10-10240 disk_type String N M1 availability_zone Availability zone where the instance is created String Y jp-east-1a | jp-east-1b subnet_group_id Subnet group where the DB instance will be deployed to String Y *Only subnets with DHCP ON can be specified It is necessary to have a set of subnets that include at least two availability zones
The specifiable values can be retrieved using the get DB subnet group list API (GET /v1.0/{tenantId}/subnetgroups)
publicly_accessible
Whether an Internet connection is possible during deployment of the DB instance Boolean N true | false
Default value:
true
*true: External Internet connections are permitted
If True is specified, the subnet specified in subnet_group_id must be connected to ext-net
false: Access from within VPC only
security_group_ids.
ID list of the VPC security group List
(String list)
N List of the VPC security group
Default:
default security group
*Specify the VPC security group.
The specifiable values can be retrieved by executing the Networking service API
multi Multi DB option Boolean N true | false
Default value:
false
multi_az Multi availability zone option Boolean N true | false
Default value:
false
Id ID of the DB instance String N Default : random value name Name of the DB instance String N Default :
Random value
backup_retention_period
Backup retention period (in days) Integer N 0 to 10
Default: 0
*Automatic backup will not be performed when the value is 0. preferred_backup_window
Backup time slot String N Format: hh24:mi-hh24:mi
Default:
A random thirty-minute-period within the ten-hour-period prescribed for each region
*If automatic backups are enabled, specify the timeslot when the daily backups are to be performed
*It is necessary to specify a timeslot from thirty minutes to twenty-three hours and 30 minutes
- Eastern Japan Region 1 (jp-east-1): 17:00-03:00 UTC
- Western Japan Region 1 (jp-west-1): 17:00-03:00 UTC
*Specify times in UTC format
*You cannot specify a timeslot that overlaps the preferred maintenance window
*Backups may take longer than thirty minutes, depending on the backup conditions
preferred_maintenance_window
Maintenance time slot String N Format:
ddd:hh24:mi-ddd:hh24:mi
Default:
A random thirty-minute period within the ten-hour period prescribed for each region (the day of the week is also determined randomly)
*Specify the timeslot when weekly maintenance is to be performed.
*It is necessary to specify a timeslot from thirty minutes to twenty-three hours and 30 minutes
A thirty-minute period within the ten-hour period prescribed for each region will be randomly determined (the day of the week is also determined randomly)
Example: Sun:0500-Sun:06:00
Day value: Mon, Tue, Wed, Thu, Fri, Sat, Sun
auto_minor_version_upgrade
Automatic minor version upgrade Boolean N Default:
true
True: Perform automatic minor version upgrade port Port number Integer N 1024 to 32767
Default value:
26500
masteruser_name Administrator user name String N Default :
postgres
-
Up to 63 alphanumeric characters can be used
- The first character must be an alphabetic character or an underscore
masteruser_password
Administrator password String Y Up to 1024 characters character_set Character encoding String N Default: UTF8
The specifiable values
can be retrieved using get DB engine information (GET /v1.0/{tenantId}/engineversion)
collate Collating sequence String N Default: C
The specifiable values
can be retrieved using get DB engine information (GET /v1.0/{tenantId}/engineversion)
parameter_group_id
Name of the DB parameter group String N DB parameter group ID
Default: default parameter group
The specifiable values
can be retrieved using get DB parameter group list (GET /v1.0/{tenantId}/parametergroups)
engine Name of the DB engine String N enterprisepostgres
|
symfoware
Default:
enterprisepostgres
engine_version DB version String N Default: Latest version The specifiable values
can be retrieved using get DB engine information (GET /v1.0/{tenantId}/engineversion)
databases List of the DB structure Map
(Database structure)
N users List of the user structure Map
(User structure)
N auto_maintenance
Whether auto maintenance is to be performed
English:
Whether an auto maintenance is possible
Boolean N true | false
Default: true
If this parameter is set to false, no auto maintenance is performed even if preferredMaintenanceWindow is encountered.
If it is changed to true, auto maintenance starts with the next preferredMaintenanceWindow.
-
Database structure
Parameters Description Type Mandatory Value Remarks name DB name String Y DB identifier
-
Up to 63 alphanumeric characters can be used
- The first character must be an alphabetic character or an underscore
-
-
User structures
Parameters Description Type Mandatory Value Remarks name DB user name String Y -
Up to 63 alphanumeric characters can be used
- The first character must be an alphabetic character or an underscore
password Password String Y Up to 1024 characters databases Databases that this user can log in to List
(String list)
Y -