Skip to content

Commit

Permalink
[Dashboards] Mark restricted_roles as deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelmcchen committed May 16, 2024
1 parent b9b64af commit 7fd1b95
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions datadog/resource_datadog_dashboard.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ func resourceDatadogDashboard() *schema.Resource {
Optional: true,
Elem: &schema.Schema{Type: schema.TypeString},
ConflictsWith: []string{"is_read_only"},
Description: "UUIDs of roles whose associated users are authorized to edit the dashboard.",
Description: "**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)",
},
"template_variable": {
Type: schema.TypeList,
Expand Down Expand Up @@ -135,8 +136,8 @@ func resourceDatadogDashboard() *schema.Resource {
Optional: true,
Default: false,
ConflictsWith: []string{"restricted_roles"},
Description: "Whether this dashboard is read-only.",
Deprecated: "Prefer using `restricted_roles` to define which roles are required to edit the dashboard.",
Description: "**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)",
},
"tags": {
Type: schema.TypeList,
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -738,10 +738,10 @@ resource "datadog_dashboard" "free_dashboard" {

- `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.
- `description` (String) The description of the dashboard.
- `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`.
- `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`.
- `notify_list` (Set of String) The list of handles for the users to notify when changes are made to this dashboard.
- `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`.
- `restricted_roles` (Set of String) UUIDs of roles whose associated users are authorized to edit the dashboard.
- `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)
- `tags` (List of String) A list of tags assigned to the Dashboard. Only team names of the form `team:<name>` are supported.
- `template_variable` (Block List) The list of template variables for this dashboard. (see [below for nested schema](#nestedblock--template_variable))
- `template_variable_preset` (Block List) The list of selectable template variable presets for this dashboard. (see [below for nested schema](#nestedblock--template_variable_preset))
Expand Down

0 comments on commit 7fd1b95

Please sign in to comment.