IBM::RDS::Instance
This resource type represents a database instance on RDS.
The blueprint uses the core properties and extended properties, if any, from this resource type. Review and configure the applicable heat resources that apply to your configuration information.
In the blueprint designer, you can configure the properties that the
following table includes. Properties are listed as either core
or extended.
Each type
of property is located in separate sections of the heat resource that you can view in the blueprint
designer. You set the core properties in the properties section and set the extended properties in
the metadata section of the blueprint.
| Name | Type | Required | Core or extended | Description |
|---|---|---|---|---|
| allocated_storage | String | False | Core | The name of the database option group that is associated with this instance. |
| availability_zone | String | False | Core | The EC2 Availability Zone in which the DB instance is created. |
| backup_retention_period | Integer | False | Core | The number of days for which automated backups are retained. |
| backup-window | String | False | Core | The daily time range during which automated backups are created, with the
format hh24:mi-hh24:mi, such as 23:30-23:50 . |
| db_instance_class | String | False | Core | The compute and memory capacity of the database instance, such as
d.t1.micro or db.m2.xlarge. |
| db_name | String | False | Core | For MySQL or PostgreSQL, the name of the database to create. For Oracle, the
SID of the instance. For SQLServer, specify null. |
| engine | String | True | Core | The database engine. |
| engine_version | String | True | Core | The version of the database engine to be used for this instance. |
| license_model | String | False | Core | The license model information for this instance. |
| instance_creation_timeout | Integer | False | Core | The number of seconds to wait for the instance to be created. |
| maintenance_window | String | False | Core | The daily time range for Amazon RDS to apply pending modifications, with the
format hh24:mi-hh24:mi, such as 23:30-23:50 . |
| master_password | String | True | Core | The password for the master database user. |
| master_username | String | True | Core | The user name of the master user for the client database instance. |
| multi_az | Boolean | False | Core | Specifies if the database instance is a multi-availability zone deployment. |
| name | String | True | Core | The name of the RDS database instance. |
| option_group | String | False | Core | The name of the database option group that is associated with the instance. |
| parameter_group | String | False | Core | The name of the database parameter group that is associated with the instance. |
| port | Integer | False | Core | The port that the database instance uses for application connections. |
| publicly_accessible | Boolean | False | Core | Specify yes to allow EC2 instances and devices outside the
VPC to connect to the database instance. |
| subnet_group | String | False | Core | The database subnet group that is associated with a database instance. Specify this parameter if you are launching into a VPC. |
| vpc_security_group_ids | List | False | Core | A list of VPC security group IDs. |
| Name | Description |
|---|---|
| endpoint_address | The endpoint address of the database instance. |
| endpoint_port | The endpoint port of the database instance. |