Skip to content

Commit 8ae6861

Browse files
modular-magicianEdward Sun
andauthored
add desc to schema for google_project_iam_custom_role (#3683) (#2219)
Co-authored-by: Edward Sun <[email protected]> Signed-off-by: Modular Magician <[email protected]> Co-authored-by: Edward Sun <[email protected]>
1 parent 99fd4cb commit 8ae6861

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

.changelog/3683.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:none
2+
3+
```

google-beta/resource_google_project_iam_custom_role.go

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,42 +25,50 @@ func resourceGoogleProjectIamCustomRole() *schema.Resource {
2525
Type: schema.TypeString,
2626
Required: true,
2727
ForceNew: true,
28+
Description: `The camel case role id to use for this role. Cannot contain - characters.`,
2829
ValidateFunc: validateIAMCustomRoleID,
2930
},
3031
"title": {
31-
Type: schema.TypeString,
32-
Required: true,
32+
Type: schema.TypeString,
33+
Required: true,
34+
Description: `A human-readable title for the role.`,
3335
},
3436
"permissions": {
35-
Type: schema.TypeSet,
36-
Required: true,
37-
MinItems: 1,
38-
Elem: &schema.Schema{Type: schema.TypeString},
37+
Type: schema.TypeSet,
38+
Required: true,
39+
MinItems: 1,
40+
Description: `The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.`,
41+
Elem: &schema.Schema{Type: schema.TypeString},
3942
},
4043
"project": {
41-
Type: schema.TypeString,
42-
Optional: true,
43-
Computed: true,
44-
ForceNew: true,
44+
Type: schema.TypeString,
45+
Optional: true,
46+
Computed: true,
47+
ForceNew: true,
48+
Description: `The project that the service account will be created in. Defaults to the provider project configuration.`,
4549
},
4650
"stage": {
4751
Type: schema.TypeString,
4852
Optional: true,
4953
Default: "GA",
54+
Description: `The current launch stage of the role. Defaults to GA.`,
5055
ValidateFunc: validation.StringInSlice([]string{"ALPHA", "BETA", "GA", "DEPRECATED", "DISABLED", "EAP"}, false),
5156
DiffSuppressFunc: emptyOrDefaultStringSuppress("ALPHA"),
5257
},
5358
"description": {
54-
Type: schema.TypeString,
55-
Optional: true,
59+
Type: schema.TypeString,
60+
Optional: true,
61+
Description: `A human-readable description for the role.`,
5662
},
5763
"deleted": {
58-
Type: schema.TypeBool,
59-
Computed: true,
64+
Type: schema.TypeBool,
65+
Computed: true,
66+
Description: `The current deleted state of the role.`,
6067
},
6168
"name": {
62-
Type: schema.TypeString,
63-
Computed: true,
69+
Type: schema.TypeString,
70+
Computed: true,
71+
Description: `The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.`,
6472
},
6573
},
6674
}

0 commit comments

Comments
 (0)