Skip to content

Commit

Permalink
Update property descriptions for Dashboard RBAC release (#1251)
Browse files Browse the repository at this point in the history
* Update property descriptions for Dashboard RBAC release

* Add .md file to branch
  • Loading branch information
matt-miller-ddog authored Oct 29, 2021
1 parent 0ad8c3f commit bed6ba2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
17 changes: 9 additions & 8 deletions datadog/resource_datadog_dashboard.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,19 +81,12 @@ func resourceDatadogDashboard() *schema.Resource {
Computed: true,
Description: "The URL of the dashboard.",
},
"is_read_only": {
Type: schema.TypeBool,
Optional: true,
Default: false,
ConflictsWith: []string{"restricted_roles"},
Description: "Whether this dashboard is read-only.",
},
"restricted_roles": {
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Schema{Type: schema.TypeString},
ConflictsWith: []string{"is_read_only"},
Description: "Role UUIDs corresponding to users authorized to edit the dashboard. **This feature is currently in beta.**",
Description: "UUIDs of roles whose associated users are authorized to edit the dashboard.",
},
"template_variable": {
Type: schema.TypeList,
Expand Down Expand Up @@ -129,6 +122,14 @@ func resourceDatadogDashboard() *schema.Resource {
Description: "A list of dashboard lists this dashboard should be removed from. Internal only.",
Elem: &schema.Schema{Type: schema.TypeInt},
},
"is_read_only": {
Type: schema.TypeBool,
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.",
},
},
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -691,10 +691,10 @@ resource "datadog_dashboard" "free_dashboard" {

- **dashboard_lists** (Set of Number) A list of dashboard lists this dashboard belongs to.
- **description** (String) The description of the dashboard.
- **is_read_only** (Boolean) Whether this dashboard is read-only.
- **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.
- **notify_list** (List 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) Role UUIDs corresponding to users authorized to edit the dashboard. **This feature is currently in beta.**
- **restricted_roles** (Set of String) UUIDs of roles whose associated users are authorized to edit the dashboard.
- **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))
- **url** (String) The URL of the dashboard.
Expand Down

0 comments on commit bed6ba2

Please sign in to comment.