Skip to content

Commit 1e70f87

Browse files
Merge pull request #620 from RedisLabs/docs/add-aa-sub-regions-datasource-docs
docs: adding documentation for datasource and aligning schema docs
2 parents ed37f50 + fd69577 commit 1e70f87

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: "rediscloud"
3+
page_title: "Redis Cloud: rediscloud_active_active_subscription_regions"
4+
description: |-
5+
Active-Active subscription regions data source in the Redis Cloud Terraform provider.
6+
---
7+
8+
# Data Source: rediscloud_active_active_subscription_regions
9+
10+
The Active-Active subscription regions data source allows access to the regions associated with an Active-Active subscription within your Enterprise Cloud Account.
11+
12+
## Example Usage
13+
14+
```terraform
15+
16+
data "rediscloud_active_active_subscription_regions" "example" {
17+
subscription_name = rediscloud_active_active_subscription.example.name
18+
}
19+
20+
output "rediscloud_active_active_subscription_regions" {
21+
value = data.rediscloud_active_active_subscription_regions.example.regions
22+
}
23+
```
24+
25+
## Argument Reference
26+
27+
* `subscription_name` - (Required) The name of the g subscription.
28+
29+
## Attribute Reference
30+
31+
* `subscription_name` - The name of the subscription.
32+
* `regions` - A list of regions associated with an Active-Active subscription.
33+
34+
Each block within the `regions` list supports:
35+
36+
* `region` - Deployment region as defined by the cloud provider.
37+
* `networking_deployment_cidr` - Deployment CIDR mask.
38+
* `vpc_id` - VPC ID for the region.
39+
* `databases` - A list of databases found in the region.
40+
41+
The `databases` block supports:
42+
43+
* `database_id` - A numeric ID for the database.
44+
* `database_name` - The name of the database.
45+
* `write_operations_per_second` - Write operations per second for the database.
46+
* `read_operations_per_second` - Read operations per second for the database.

provider/datasource_rediscloud_active_active_subscription_regions.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ func dataSourceRedisCloudActiveActiveSubscriptionRegions() *schema.Resource {
1616

1717
Schema: map[string]*schema.Schema{
1818
"subscription_name": {
19-
Description: "The name of the subscription",
19+
Description: "The name of the Active-Active subscription",
2020
Type: schema.TypeString,
2121
Required: true,
2222
},
2323
"regions": {
24-
Description: "A list of regions from an active active subscription",
24+
Description: "A list of regions associated with an Active-Active subscription",
2525
Type: schema.TypeList,
2626
Computed: true,
2727
Elem: &schema.Resource{
2828
Schema: map[string]*schema.Schema{
2929
"region": {
30-
Description: "Deployment region as defined by cloud provider",
30+
Description: "Deployment region as defined by the cloud provider",
3131
Type: schema.TypeString,
3232
Computed: true,
3333
},
@@ -53,7 +53,7 @@ func dataSourceRedisCloudActiveActiveSubscriptionRegions() *schema.Resource {
5353
Computed: true,
5454
},
5555
"database_name": {
56-
Description: "A meaningful name to identify the database",
56+
Description: "The name of the database",
5757
Type: schema.TypeString,
5858
Computed: true,
5959
},

0 commit comments

Comments
 (0)