Big Data Instance
=================
Big Data Instances are database instances which store and process big data. An example of this type of instance would be AWS Redshift. 
This class inherits from TopLevelResource and has direct access to the resource’s database object.

+-----------------------------+-------------------------------------------------------------------------------------------------+
| Attribute                   | Description                                                                                     |
+=============================+=================================================================================================+
| attr resource_id:           | The primary resource identifier that takes the form of a prefix followed by numbers and letters |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| organization_service_id     | The ID of the parent organization service (cloud)                                               |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| region_name                 | The region that the instance resides in                                                         |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| instance_id                 | The provider ID of the instance                                                                 |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| name                        | The name of the instance                                                                        |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| instance_type               | The type of instance                                                                            |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| instance_flavor_resource_id | The resource ID of the type (flavor) this instance runs on                                      |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| state                       | The state of the big data instance                                                              |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| availability_zone           | The zone where the big data instance lives                                                      |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| endpoint_port               | The port that the big data instance listens on                                                  |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| version                     | The software version the big data instance leverages                                            |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| db_name                     | The name of the master database                                                                 |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| backup_retention            | An integer representing the number of days that automatic snapshots are retained for            |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| master_username             | The username of the master user                                                                 |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| encrypted                   | Denotes if the data stored on the instance is encrypted                                         |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| publicly_accessible         | Denotes if the instance can be accessed over the Internet                                       |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| access_lists                | Returns a list of associated security groups                                                    |
+-----------------------------+-------------------------------------------------------------------------------------------------+
| instance_flavor             | Returns a flavor object which contains information on the size of the instance                  |
+-----------------------------+-------------------------------------------------------------------------------------------------+

.. container:: magic-block-textarea

   **Big Data Instance Operations**

   | ``delete(wait_for_result=True, user_resource_id=None)``
   | Delete this resource. If wrapped in a with
     JobQueue() block, this will queue the
     deletion job to the wrapped queue,
     otherwise it calls immediately.
   
   ``static get_db_class()``
   
   | ``get_instance_type()``
   | Retrieve the instance type of the resource.
   
   ``static get_provider_id_field()``
   
   ``static get_resource_type()``
   
   | ``get_state()``
   | Retrieve the instance state.
   
   ``get_supported_actions()``
   
   | ``handle_resource_created(user_resource_id=None, project_resource_id=None)``
   | This should be called when a resource is
     created/discovered after the basic data is
     added to the database. This gives an
     opportunity for post-addition hooks
     (assignment to projects/groups, alerts,
     etc.).
   
   | ``handle_resource_destroyed(user_resource_id=None, project_resource_id=None)``
   | This should be called when a resource is
     destroyed before the basic data is removed
     from the database. This gives an
     opportunity for pre-destruction hooks
     (removal from projects/groups, alerts,
     etc.).
   
   | ``handle_resource_modified(resource, *args, **kwargs)``
   | This should be called when a resource is
     modified after the new data has been
     updated in the DB session. This gives an
     opportunity for post-modification hooks.
   
   ``instance``
   
   ``top_level_resource = True``