Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[restriction_policy] Update restriction_policy resource documentation #1995

Merged
merged 1 commit into from
Jul 7, 2023
Merged

[restriction_policy] Update restriction_policy resource documentation #1995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions datadog/fwprovider/resource_datadog_restriction_policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ func (r *RestrictionPolicyResource) Metadata(_ context.Context, request resource

func (r *RestrictionPolicyResource) Schema(_ context.Context, _ resource.SchemaRequest, response *resource.SchemaResponse) {
response.Schema = schema.Schema{
Description: "Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies. See this page for more details https://docs.datadoghq.com/api/latest/restriction-policies/#supported-relations-for-resources.",
Description: "Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies.",
Attributes: map[string]schema.Attribute{
"resource_id": schema.StringAttribute{
Required: true,
Description: "Identifier for the resource, formatted as resource_type:resource_id.",
Description: "Identifier for the resource, formatted as resource_type:resource_id.\n\nNote: dashboard resource is currently not supported",
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
Expand All @@ -68,11 +68,11 @@ func (r *RestrictionPolicyResource) Schema(_ context.Context, _ resource.SchemaR
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"relation": schema.StringAttribute{
Optional: true,
Description: "The role/level of access.",
Required: true,
Description: "The role/level of access. See this page for more details https://docs.datadoghq.com/api/latest/restriction-policies/#supported-relations-for-resources",
},
"principals": schema.SetAttribute{
Optional: true,
Required: true,
Description: "An array of principals. A principal is a subject or group of subjects. Each principal is formatted as `type:id`. Supported types: `role` and `org`. The org ID can be obtained through the api/v2/users API.",
ElementType: types.StringType,
},
Expand Down
10 changes: 6 additions & 4 deletions docs/resources/restriction_policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "datadog_restriction_policy Resource - terraform-provider-datadog"
subcategory: ""
description: |-
Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies. See this page for more details https://docs.datadoghq.com/api/latest/restriction-policies/#supported-relations-for-resources.
Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies.
---

# datadog_restriction_policy (Resource)

Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies. See this page for more details https://docs.datadoghq.com/api/latest/restriction-policies/#supported-relations-for-resources.
Provides a Datadog RestrictionPolicy resource. This can be used to create and manage Datadog restriction policies.

## Example Usage

Expand Down Expand Up @@ -36,6 +36,8 @@ resource "datadog_restriction_policy" "foo" {

- `resource_id` (String) Identifier for the resource, formatted as resource_type:resource_id.

Note: dashboard resource is currently not supported

### Optional

- `bindings` (Block Set) (see [below for nested schema](#nestedblock--bindings))
Expand All @@ -47,10 +49,10 @@ resource "datadog_restriction_policy" "foo" {
<a id="nestedblock--bindings"></a>
### Nested Schema for `bindings`

Optional:
Required:

- `principals` (Set of String) An array of principals. A principal is a subject or group of subjects. Each principal is formatted as `type:id`. Supported types: `role` and `org`. The org ID can be obtained through the api/v2/users API.
- `relation` (String) The role/level of access.
- `relation` (String) The role/level of access. See this page for more details https://docs.datadoghq.com/api/latest/restriction-policies/#supported-relations-for-resources

## Import

Expand Down