Modify posture deployment field descriptions (#9900) (hashicorp#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]>
askubis · Feb 5, 2024 · 59922e7 · 59922e7
1 parent a568517
commit 59922e7
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 16 deletions.
diff --git a/.changelog/9900.txt b/.changelog/9900.txt
@@ -0,0 +1,2 @@
+```release-note:none
+```
diff --git a/google-beta/services/securityposture/resource_securityposture_posture_deployment.go b/google-beta/services/securityposture/resource_securityposture_posture_deployment.go
@@ -70,7 +70,7 @@ func ResourceSecurityposturePostureDeployment() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				Description: `Relative name of the posture which needs to be deployed. It should be in the format:
-  organizations/<ORG_ID>/locations/<LOCATION>/postures/<postureID>`,
+  organizations/{organization_id}/locations/{location}/postures/{posture_id}`,
 			},
 			"posture_revision_id": {
 				Type:        schema.TypeString,
@@ -82,9 +82,9 @@ func ResourceSecurityposturePostureDeployment() *schema.Resource {
 				Required: true,
 				ForceNew: true,
 				Description: `The resource on which the posture should be deployed. This can be in one of the following formats:
-projects/<project_number>
-folders/<folder_number>
-organizations/<organization_id>`,
+projects/{project_number},
+folders/{folder_number},
+organizations/{organization_id}`,
 			},
 			"description": {
 				Type:        schema.TypeString,
@@ -101,14 +101,14 @@ organizations/<organization_id>`,
 				Computed: true,
 				Description: `This is an output only optional field which will be filled in case when
 PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-It denotes the desired Posture to be deployed.`,
+It denotes the desired posture to be deployed.`,
 			},
 			"desired_posture_revision_id": {
 				Type:     schema.TypeString,
 				Computed: true,
 				Description: `This is an output only optional field which will be filled in case when
 PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-It denotes the desired Posture revision_id to be deployed.`,
+It denotes the desired posture revision_id to be deployed.`,
 			},
 			"etag": {
 				Type:        schema.TypeString,
@@ -134,9 +134,10 @@ CREATE/UPDATE/DELETE methods.`,
 				Description: `If set, there are currently changes in flight to the posture deployment.`,
 			},
 			"state": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Description: `State of the posture deployment.`,
+				Type:     schema.TypeString,
+				Computed: true,
+				Description: `State of the posture deployment. A posture deployment can be in the following terminal states:
+ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.`,
 			},
 			"update_time": {
 				Type:        schema.TypeString,

diff --git a/website/docs/r/securityposture_posture_deployment.html.markdown b/website/docs/r/securityposture_posture_deployment.html.markdown
@@ -77,14 +77,14 @@ The following arguments are supported:
 * `target_resource` -
   (Required)
   The resource on which the posture should be deployed. This can be in one of the following formats:
-  projects/<project_number>
-  folders/<folder_number>
-  organizations/<organization_id>
+  projects/{project_number},
+  folders/{folder_number},
+  organizations/{organization_id}
 
 * `posture_id` -
   (Required)
   Relative name of the posture which needs to be deployed. It should be in the format:
-    organizations/<ORG_ID>/locations/<LOCATION>/postures/<postureID>
+    organizations/{organization_id}/locations/{location}/postures/{posture_id}
 
 * `posture_revision_id` -
   (Required)
@@ -121,7 +121,8 @@ In addition to the arguments listed above, the following computed attributes are
   Name of the posture deployment instance.
 
 * `state` -
-  State of the posture deployment.
+  State of the posture deployment. A posture deployment can be in the following terminal states:
+  ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.
 
 * `create_time` -
   Time the posture deployment was created in UTC.
@@ -138,12 +139,12 @@ In addition to the arguments listed above, the following computed attributes are
 * `desired_posture_id` -
   This is an output only optional field which will be filled in case when
   PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-  It denotes the desired Posture to be deployed.
+  It denotes the desired posture to be deployed.
 
 * `desired_posture_revision_id` -
   This is an output only optional field which will be filled in case when
   PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
-  It denotes the desired Posture revision_id to be deployed.
+  It denotes the desired posture revision_id to be deployed.
 
 * `failure_message` -
   This is a output only optional field which will be filled in case where