Skip to content

Commit 7fd1b95

Browse files
committed
[Dashboards] Mark restricted_roles as deprecated
1 parent b9b64af commit 7fd1b95

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

datadog/resource_datadog_dashboard.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ func resourceDatadogDashboard() *schema.Resource {
9494
Optional: true,
9595
Elem: &schema.Schema{Type: schema.TypeString},
9696
ConflictsWith: []string{"is_read_only"},
97-
Description: "UUIDs of roles whose associated users are authorized to edit the dashboard.",
97+
Description: "**Deprecated** UUIDs of roles whose associated users are authorized to edit the dashboard.",
98+
Deprecated: "This attribute is deprecated and will be removed in a future major version release. Please use the `datadog_restriction_policy` resource to manage authorization (https://docs.datadoghq.com/dashboards/guide/how-to-use-terraform-to-restrict-dashboard-edit/#restricting-a-dashboard-using-a-restriction-policy)",
9899
},
99100
"template_variable": {
100101
Type: schema.TypeList,
@@ -135,8 +136,8 @@ func resourceDatadogDashboard() *schema.Resource {
135136
Optional: true,
136137
Default: false,
137138
ConflictsWith: []string{"restricted_roles"},
138-
Description: "Whether this dashboard is read-only.",
139-
Deprecated: "Prefer using `restricted_roles` to define which roles are required to edit the dashboard.",
139+
Description: "**Deprecated** Whether this dashboard is read-only.",
140+
Deprecated: "This attribute is deprecated and will be removed in a future major version release. Please use the `datadog_restriction_policy` resource to manage authorization (https://docs.datadoghq.com/dashboards/guide/how-to-use-terraform-to-restrict-dashboard-edit/#restricting-a-dashboard-using-a-restriction-policy)",
140141
},
141142
"tags": {
142143
Type: schema.TypeList,

docs/resources/dashboard.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -738,10 +738,10 @@ resource "datadog_dashboard" "free_dashboard" {
738738

739739
- `dashboard_lists` (Set of Number) A list of dashboard lists this dashboard belongs to. This attribute should not be set if managing the corresponding dashboard lists using Terraform as it causes inconsistent behavior.
740740
- `description` (String) The description of the dashboard.
741-
- `is_read_only` (Boolean, Deprecated) Whether this dashboard is read-only. **Deprecated.** Prefer using `restricted_roles` to define which roles are required to edit the dashboard. Defaults to `false`.
741+
- `is_read_only` (Boolean, Deprecated) **Deprecated** Whether this dashboard is read-only. **Deprecated.** This attribute is deprecated and will be removed in a future major version release. Please use the `datadog_restriction_policy` resource to manage authorization (https://docs.datadoghq.com/dashboards/guide/how-to-use-terraform-to-restrict-dashboard-edit/#restricting-a-dashboard-using-a-restriction-policy) Defaults to `false`.
742742
- `notify_list` (Set of String) The list of handles for the users to notify when changes are made to this dashboard.
743743
- `reflow_type` (String) The reflow type of a new dashboard layout. Set this only when layout type is `ordered`. If set to `fixed`, the dashboard expects all widgets to have a layout, and if it's set to `auto`, widgets should not have layouts. Valid values are `auto`, `fixed`.
744-
- `restricted_roles` (Set of String) UUIDs of roles whose associated users are authorized to edit the dashboard.
744+
- `restricted_roles` (Set of String, Deprecated) **Deprecated** UUIDs of roles whose associated users are authorized to edit the dashboard. **Deprecated.** This attribute is deprecated and will be removed in a future major version release. Please use the `datadog_restriction_policy` resource to manage authorization (https://docs.datadoghq.com/dashboards/guide/how-to-use-terraform-to-restrict-dashboard-edit/#restricting-a-dashboard-using-a-restriction-policy)
745745
- `tags` (List of String) A list of tags assigned to the Dashboard. Only team names of the form `team:<name>` are supported.
746746
- `template_variable` (Block List) The list of template variables for this dashboard. (see [below for nested schema](#nestedblock--template_variable))
747747
- `template_variable_preset` (Block List) The list of selectable template variable presets for this dashboard. (see [below for nested schema](#nestedblock--template_variable_preset))

0 commit comments

Comments
 (0)