new doc

docs/resources/rediscloud_database.md

@@ -5,6 +5,134 @@ description: |-
 Database resource in the Terraform provider Redis Cloud.
 ---
 
+# Resource: rediscloud_database
+
+Creates a Database within a specified Subscription in your Redis Enterprise Cloud Account.
+
+## Example Usage
+
+```hcl
+data "rediscloud_payment_method" "card" {
+  card_type = "Visa"
+}
+
+data "rediscloud_cloud_account" "account" {
+  exclude_internal_account = true
+  provider_type = "AWS"
+}
+
+resource "rediscloud_subscription" "example" {
+
+  name = "example"
+  payment_method = "credit-card"
+  payment_method_id = data.rediscloud_payment_method.card.id
+  memory_storage = "ram"
+
+  cloud_provider {
+    provider = data.rediscloud_cloud_account.account.provider_type
+    cloud_account_id = data.rediscloud_cloud_account.account.id
+    region {
+      region = "eu-west-1"
+      networking_deployment_cidr = "10.0.0.0/24"
+      preferred_availability_zones = ["eu-west-1a"]
+    }
+  }
+
+  // This block needs to be defined for provisioning a new subscription.
+  // This allows creating a well-optimised hardware specification for databases in the cluster
+  creation_plan {
+    average_item_size_in_bytes = 1
+    memory_limit_in_gb = 2
+    quantity = 1
+    replication=false
+    support_oss_cluster_api=false
+    throughput_measurement_by = "operations-per-second"
+    throughput_measurement_value = 10000
+    modules = ["RediSearch", "RedisBloom"]
+  }
+}
+
+// The primary database to provision
+resource "rediscloud_database" "example" {
+    subscription_id = rediscloud_subscription.example.id
+    name = "example-database"
+    protocol = "redis"
+    memory_limit_in_gb = 1
+    data_persistence = "none"
+    throughput_measurement_by = "operations-per-second"
+    throughput_measurement_value = 10000
+    password = "example-password"
+    support_oss_cluster_api = false 
+    external_endpoint_for_oss_cluster_api = false
+    replication = false
+    average_item_size_in_bytes = 0
+    client_ssl_certificate = "" 
+    periodic_backup_path = ""
+   
+    modules = [
+        {
+          "name": "RedisJSON"
+        },
+        {
+          "name": "RedisBloom"
+        }
+    ]
+    
+    alert {
+      name = "dataset-size"
+      value = 40
+    }
+}
+
+// An example of how a replica database can be provisioned
+resource "rediscloud_database" "example_replica" {
+    subscription_id = rediscloud_subscription.example.id
+    name = "example-replica"
+    protocol = "redis"
+    memory_limit_in_gb = 1
+    throughput_measurement_by = "operations-per-second"
+    throughput_measurement_value = 10000
+    replica_of = [format("redis://%s", rediscloud_database.example.public_endpoint)]
+} 
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `subscription_id`: (Required) The ID of the subscription to create the database in.
+* `name` - (Required) A meaningful name to identify the database. Caution should be taken when changing this value - see
+  the top of the page for more information.
+* `throughput_measurement_by` - (Required) Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
+* `throughput_measurement_value` - (Required) Throughput value (as applies to selected measurement method)
+* `memory_limit_in_gb` - (Required) Maximum memory usage for this specific database
+* `protocol` - (Optional) The protocol that will be used to access the database, (either ‘redis’ or 'memcached’) Default: ‘redis’
+* `support_oss_cluster_api` - (Optional) Support Redis open-source (OSS) Cluster API. Default: ‘false’
+* `external_endpoint_for_oss_cluster_api` - (Optional) Should use the external endpoint for open-source (OSS) Cluster API.
+  Can only be enabled if OSS Cluster API support is enabled. Default: 'false'
+* `client_ssl_certificate` - (Optional) SSL certificate to authenticate user connections
+* `periodic_backup_path` - (Optional) Path that will be used to store database backup files
+* `replica_of` - (Optional) Set of Redis database URIs, in the format `redis://user:password@host:port`, that this
+  database will be a replica of. If the URI provided is Redis Labs Cloud instance, only host and port should be provided.
+  Cannot be enabled when `support_oss_cluster_api` is enabled.
+* `modules` - (Optional) A modules object, documented below
+* `alert` - (Optional) Set of alerts to enable on the database, documented below
+* `data_persistence` - (Optional) Rate of database data persistence (in persistent storage). Default: ‘none’
+* `data_eviction` - (Optional) The data items eviction policy (either: 'allkeys-lru', 'allkeys-lfu', 'allkeys-random', 'volatile-lru', 'volatile-lfu', 'volatile-random', 'volatile-ttl' or 'noeviction'. Default: 'volatile-lru')
+* `password` - (Optional) Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated
+* `replication` - (Optional) Databases replication. Default: ‘true’
+* `average_item_size_in_bytes` - (Optional) Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes)
+  of the items stored in the database. Default: 1000
+* `source_ips` - (Optional) Set of CIDR addresses to allow access to the database. Defaults to allowing traffic.
+* `hashing_policy` - (Optional) List of regular expression rules to shard the database by. See
+  [the documentation on clustering](https://docs.redislabs.com/latest/rc/concepts/clustering/) for more information on the
+  hashing policy. This cannot be set when `support_oss_cluster_api` is set to true.
+* `enable_tls` - (Optional) Use TLS for authentication. Default: ‘false’
+
+The `alert` block supports:
+
+* `name` (Required) Alert name
+* `value` (Required) Alert value
 
 The `modules` block supports:
 
@@ -22,3 +150,25 @@ The `modules` block supports:
         }
     ]
   ```
+
+### Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `create` - (Defaults to 30 mins) Used when creating the database
+* `update` - (Defaults to 30 mins) Used when updating the database
+* `delete` - (Defaults to 10 mins) Used when destroying the database
+
+## Attribute reference
+
+* `db_id` - Identifier of the database created
+* `public_endpoint` - Public endpoint to access the database
+* `private_endpoint` - Private endpoint to access the database
+
+## Import
+`rediscloud_database` can be imported using the ID of the subscription and the ID of the database in the format {subscription ID}/{database ID}, e.g.
+
+```
+$ terraform import rediscloud_database.example_database 123456/12345678
+```
+

docs/resources/rediscloud_subscription.md

@@ -98,6 +98,7 @@ The `creation_plan` block supports:
 * `modules` - (Optional) a list of modules that will be used by the databases in this subscription. 
 Example: `modules = ["RedisJSON", RedisBloom"]`.
 * `replication` - (Required) Databases replication.
+* `quantity` - (Required) The planned number of databases.
 * `throughput_measurement_by` - (Required) Throughput measurement method, (either ‘number-of-shards’ or ‘operations-per-second’)
 * `throughput_measurement_value` - (Required) Throughput value (as applies to selected measurement method)
 * `average_item_size_in_bytes` - (Optional) Relevant only to ram-and-flash clusters. Estimated average size (measured in bytes)