Skip to content

Commit 478f87f

Browse files
authored
Update rediscloud_subscription.md (#322)
documentation adjustment
1 parent 821c6da commit 478f87f

File tree

1 file changed

+16
-19
lines changed

1 file changed

+16
-19
lines changed

docs/resources/rediscloud_subscription.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ description: |-
88
# Resource: rediscloud_subscription
99

1010
Creates a Subscription within your Redis Enterprise Cloud Account.
11-
This resource is responsible for creating subscriptions and the databases within
12-
that subscription. This allows Redis Enterprise Cloud to provision
13-
your databases defined in separate resources in the most efficient way.
11+
This resource is responsible for creating and managing subscriptions.
1412

1513
~> **Note:** The creation_plan block allows the API server to create a well-optimised hardware specification for your databases in the cluster.
1614
The attributes inside the block are used by the provider to create initial
@@ -31,9 +29,9 @@ data "rediscloud_cloud_account" "account" {
3129
provider_type = "AWS"
3230
}
3331
34-
resource "rediscloud_subscription" "example" {
32+
resource "rediscloud_subscription" "subscription-resource" {
3533
36-
name = "example"
34+
name = "subscription-name"
3735
payment_method = "credit-card"
3836
payment_method_id = data.rediscloud_payment_method.card.id
3937
memory_storage = "ram"
@@ -68,8 +66,8 @@ resource "rediscloud_subscription" "example" {
6866
The following arguments are supported:
6967

7068
* `name` - (Required) A meaningful name to identify the subscription
71-
* `payment_method` (Optional) The payment method for the requested subscription, (either `credit-card` or `marketplace`). If `credit-card` is specified, `payment_method_id` must be defined.
72-
* `payment_method_id` - (Optional) A valid payment method pre-defined in the current account. This value is __Optional__ for AWS/GCP Marketplace accounts, but __Required__ for all other account types.
69+
* `payment_method` (Optional) The payment method for the requested subscription, (either `credit-card` or `marketplace`). If `credit-card` is specified, `payment_method_id` must be defined. Default: 'credit-card'
70+
* `payment_method_id` - (Optional) A valid payment method pre-defined in the current account. This value is __Optional__ for AWS/GCP Marketplace accounts, but __Required__ for all other account types
7371
* `memory_storage` - (Optional) Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’
7472
* `allowlist` - (Optional) An allowlist object, documented below
7573
* `cloud_provider` - (Required) A cloud provider object, documented below
@@ -80,30 +78,29 @@ The `allowlist` block supports:
8078
* `security_group_ids` - (Required) Set of security groups that are allowed to access the databases associated with this subscription
8179
* `cidrs` - (Optional) Set of CIDR ranges that are allowed to access the databases associated with this subscription
8280

83-
~> **Note:** `allowlist` is only available when you run on your own cloud account, and not one that Redis Labs provided (i.e `cloud_account_id` != 1)
81+
~> **Note:** `allowlist` is only available when you run on your own cloud account, and not one that Redis provided (i.e `cloud_account_id` != 1)
8482

8583
The `cloud_provider` block supports:
8684

8785
* `provider` - (Optional) The cloud provider to use with the subscription, (either `AWS` or `GCP`). Default: ‘AWS’
8886
* `cloud_account_id` - (Optional) Cloud account identifier. Default: Redis Labs internal cloud account
8987
(using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created
9088
only with Redis Labs internal cloud account
91-
* `region` - (Required) Cloud networking details, per region, documented below
89+
* `region` - (Required) A region object, documented below
9290

9391
The `creation_plan` block supports:
9492

9593
* `memory_limit_in_gb` - (Required) Maximum memory usage that will be used for your largest planned database.
9694
* `modules` - (Required) a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage.
97-
Example: `modules = ["RedisJSON", RedisBloom"]`.
95+
Example: `modules = ["RedisJSON", RedisBloom"]`
9896
* `support_oss_cluster_api` - (Optional) Support Redis open-source (OSS) Cluster API. Default: ‘false’
99-
* `replication` - (Required) Databases replication. Set to `true` if any of your databases will use replication.
100-
* `quantity` - (Required) The planned number of databases in the subscription.
97+
* `replication` - (Required) Databases replication. Set to `true` if any of your databases will use replication
98+
* `quantity` - (Required) The planned number of databases in the subscription
10199
* `throughput_measurement_by` - (Required) Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
102-
* `throughput_measurement_value` - (Required) Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value
103-
defined in one of your databases.
104-
* `average_item_size_in_bytes` - (Optional) Relevant only to ram-and-flash clusters.
100+
* `throughput_measurement_value` - (Required) Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
101+
* `average_item_size_in_bytes` - (Optional) Relevant only to ram-and-flash clusters
105102
Estimated average size (measured in bytes) of the items stored in the database. The value needs to
106-
be the maximum average item size defined in one of your databases. Default: 0
103+
be the maximum average item size defined in one of your databases. Default: 1000
107104

108105
~>**Note:** If the number of modules exceeds the `quantity` then additional creation-plan databases will be created with the modules defined in the `modules` block.
109106

@@ -113,9 +110,9 @@ The cloud_provider `region` block supports:
113110

114111
* `region` - (Required) Deployment region as defined by cloud provider
115112
* `multiple_availability_zones` - (Optional) Support deployment on multiple availability zones within the selected region. Default: ‘false’
116-
* `networking_deployment_cidr` - (Required) Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24).
113+
* `networking_deployment_cidr` - (Required) Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24)
117114
* `networking_vpc_id` - (Optional) Either an existing VPC Id (already exists in the specific region) or create a new VPC
118-
(if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4625884ad’) and existing
115+
(if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing
119116
within the hosting account.
120117
* `preferred_availability_zones` - (Required) Availability zones deployment preferences (for the selected provider & region). If multiple_availability_zones is set to 'true', you must select three availability zones from the list.
121118

@@ -147,7 +144,7 @@ The `networks` block has these attributes:
147144
`rediscloud_subscription` can be imported using the ID of the subscription, e.g.
148145

149146
```
150-
$ terraform import rediscloud_subscription.example 12345678
147+
$ terraform import rediscloud_subscription.subscription-resource 12345678
151148
```
152149

153150
~> **Note:** the creation_plan block will be ignored during imports.

0 commit comments

Comments
 (0)