[Dashboards] Mark restricted_roles as deprecated #2410
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelmcchen
force-pushed
the
mchen/deprecate-db-rbac
branch
from
d6074b8
to
7fd1b95
Compare
brett0000FF
approved these changes
May 16, 2024
| @@ -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`. | |||
There was a problem hiding this comment.
Suggested change
| - `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`. | |
| - `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. Instead, 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) |
There was a problem hiding this comment.
Suggested change
| - `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) | |
| - `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. Instead, 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). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating the TF docs to reflect deprecation of is_read_only and restricted_roles, per the API docs - https://docs.datadoghq.com/api/latest/dashboards/