Skip to content

Commit 59922e7

Browse files
Modify posture deployment field descriptions (#9900) (#6935)
* modify posture dpeloyment field description * Update mmv1/products/securityposture/PostureDeployment.yaml * Update mmv1/products/securityposture/PostureDeployment.yaml --------- [upstream:7088e2486d94f074cb54b23d6921c58cdaf668a8] Signed-off-by: Modular Magician <[email protected]>
1 parent a568517 commit 59922e7

File tree

3 files changed

+20
-16
lines changed

3 files changed

+20
-16
lines changed

.changelog/9900.txt

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

google-beta/services/securityposture/resource_securityposture_posture_deployment.go

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ func ResourceSecurityposturePostureDeployment() *schema.Resource {
7070
Type: schema.TypeString,
7171
Required: true,
7272
Description: `Relative name of the posture which needs to be deployed. It should be in the format:
73-
organizations/<ORG_ID>/locations/<LOCATION>/postures/<postureID>`,
73+
organizations/{organization_id}/locations/{location}/postures/{posture_id}`,
7474
},
7575
"posture_revision_id": {
7676
Type: schema.TypeString,
@@ -82,9 +82,9 @@ func ResourceSecurityposturePostureDeployment() *schema.Resource {
8282
Required: true,
8383
ForceNew: true,
8484
Description: `The resource on which the posture should be deployed. This can be in one of the following formats:
85-
projects/<project_number>
86-
folders/<folder_number>
87-
organizations/<organization_id>`,
85+
projects/{project_number},
86+
folders/{folder_number},
87+
organizations/{organization_id}`,
8888
},
8989
"description": {
9090
Type: schema.TypeString,
@@ -101,14 +101,14 @@ organizations/<organization_id>`,
101101
Computed: true,
102102
Description: `This is an output only optional field which will be filled in case when
103103
PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
104-
It denotes the desired Posture to be deployed.`,
104+
It denotes the desired posture to be deployed.`,
105105
},
106106
"desired_posture_revision_id": {
107107
Type: schema.TypeString,
108108
Computed: true,
109109
Description: `This is an output only optional field which will be filled in case when
110110
PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
111-
It denotes the desired Posture revision_id to be deployed.`,
111+
It denotes the desired posture revision_id to be deployed.`,
112112
},
113113
"etag": {
114114
Type: schema.TypeString,
@@ -134,9 +134,10 @@ CREATE/UPDATE/DELETE methods.`,
134134
Description: `If set, there are currently changes in flight to the posture deployment.`,
135135
},
136136
"state": {
137-
Type: schema.TypeString,
138-
Computed: true,
139-
Description: `State of the posture deployment.`,
137+
Type: schema.TypeString,
138+
Computed: true,
139+
Description: `State of the posture deployment. A posture deployment can be in the following terminal states:
140+
ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.`,
140141
},
141142
"update_time": {
142143
Type: schema.TypeString,

website/docs/r/securityposture_posture_deployment.html.markdown

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ The following arguments are supported:
7777
* `target_resource` -
7878
(Required)
7979
The resource on which the posture should be deployed. This can be in one of the following formats:
80-
projects/<project_number>
81-
folders/<folder_number>
82-
organizations/<organization_id>
80+
projects/{project_number},
81+
folders/{folder_number},
82+
organizations/{organization_id}
8383

8484
* `posture_id` -
8585
(Required)
8686
Relative name of the posture which needs to be deployed. It should be in the format:
87-
organizations/<ORG_ID>/locations/<LOCATION>/postures/<postureID>
87+
organizations/{organization_id}/locations/{location}/postures/{posture_id}
8888

8989
* `posture_revision_id` -
9090
(Required)
@@ -121,7 +121,8 @@ In addition to the arguments listed above, the following computed attributes are
121121
Name of the posture deployment instance.
122122

123123
* `state` -
124-
State of the posture deployment.
124+
State of the posture deployment. A posture deployment can be in the following terminal states:
125+
ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.
125126

126127
* `create_time` -
127128
Time the posture deployment was created in UTC.
@@ -138,12 +139,12 @@ In addition to the arguments listed above, the following computed attributes are
138139
* `desired_posture_id` -
139140
This is an output only optional field which will be filled in case when
140141
PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
141-
It denotes the desired Posture to be deployed.
142+
It denotes the desired posture to be deployed.
142143

143144
* `desired_posture_revision_id` -
144145
This is an output only optional field which will be filled in case when
145146
PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
146-
It denotes the desired Posture revision_id to be deployed.
147+
It denotes the desired posture revision_id to be deployed.
147148

148149
* `failure_message` -
149150
This is a output only optional field which will be filled in case where

0 commit comments

Comments
 (0)