Add extra notes to critical resource properties (#4088)

This pull request adds notes to docs that need a little bit of extra
information, according to customer engineering feedback.

Fixes #4067 

Fixes #4069

provider/cmd/pulumi-resource-aws/schema.json

@@ -186944,7 +186944,7 @@
                 },
                 "name": {
                     "type": "string",
-                    "description": "The name for the public key. By default generated by this provider.\n"
+                    "description": "The name for the public key. By default generated by this provider. Note: Do not set if using the key's id in another resource (e.g. KeyGroup) since it will result in a dependency error from AWS. Instead, it is recommended to use Pulumi autonaming by leaving this property unset (default behavior) or set the `namePrefix` property to allow the provider to autoname the resource.\n"
                 },
                 "namePrefix": {
                     "type": "string",
@@ -186970,7 +186970,7 @@
                 },
                 "name": {
                     "type": "string",
-                    "description": "The name for the public key. By default generated by this provider.\n",
+                    "description": "The name for the public key. By default generated by this provider. Note: Do not set if using the key's id in another resource (e.g. KeyGroup) since it will result in a dependency error from AWS. Instead, it is recommended to use Pulumi autonaming by leaving this property unset (default behavior) or set the `namePrefix` property to allow the provider to autoname the resource.\n",
                     "willReplaceOnChanges": true
                 },
                 "namePrefix": {
@@ -187004,7 +187004,7 @@
                     },
                     "name": {
                         "type": "string",
-                        "description": "The name for the public key. By default generated by this provider.\n",
+                        "description": "The name for the public key. By default generated by this provider. Note: Do not set if using the key's id in another resource (e.g. KeyGroup) since it will result in a dependency error from AWS. Instead, it is recommended to use Pulumi autonaming by leaving this property unset (default behavior) or set the `namePrefix` property to allow the provider to autoname the resource.\n",
                         "willReplaceOnChanges": true
                     },
                     "namePrefix": {
@@ -236445,7 +236445,7 @@
                     "additionalProperties": {
                         "type": "string"
                     },
-                    "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. See example above.\n"
+                    "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. When using the triggers property you also need to set the forceNewDeployment property to True.\n"
                 },
                 "volumeConfiguration": {
                     "$ref": "#/types/aws:ecs/ServiceVolumeConfiguration:ServiceVolumeConfiguration",
@@ -236595,7 +236595,7 @@
                     "additionalProperties": {
                         "type": "string"
                     },
-                    "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. See example above.\n"
+                    "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. When using the triggers property you also need to set the forceNewDeployment property to True.\n"
                 },
                 "volumeConfiguration": {
                     "$ref": "#/types/aws:ecs/ServiceVolumeConfiguration:ServiceVolumeConfiguration",
@@ -236746,7 +236746,7 @@
                         "additionalProperties": {
                             "type": "string"
                         },
-                        "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. See example above.\n"
+                        "description": "Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `\"plantimestamp()\"`. When using the triggers property you also need to set the forceNewDeployment property to True.\n"
                     },
                     "volumeConfiguration": {
                         "$ref": "#/types/aws:ecs/ServiceVolumeConfiguration:ServiceVolumeConfiguration",

provider/doc_edits.go

@@ -26,6 +26,8 @@ import (
 
 func editRules(defaults []tfbridge.DocsEdit) []tfbridge.DocsEdit {
 	return append(defaults,
+		fixUpCloudFrontPublicKey,
+		fixUpEcsServiceName,
 		// This fixes up strings such as:
 		//
 		//	name        = "terraform-kinesis-firehose-os",
@@ -60,6 +62,31 @@ func simpleReplace(from, to string) tfbridge.DocsEdit {
 	}
 }
 
+func targetedSimpleReplace(filePath, from, to string) tfbridge.DocsEdit {
+	fromB, toB := []byte(from), []byte(to)
+	return tfbridge.DocsEdit{
+		Path: filePath,
+		Edit: func(_ string, content []byte) ([]byte, error) {
+			return bytes.ReplaceAll(content, fromB, toB), nil
+		},
+	}
+}
+
+var fixUpCloudFrontPublicKey = targetedSimpleReplace("cloudfront_public_key.html.markdown",
+	"* `name` - (Optional) The name for the public key. By default generated by this provider.",
+	"* `name` - (Optional) The name for the public key. By default generated by this provider. "+
+		"Note: Do not set if using the key's id in another resource (e.g. KeyGroup) "+
+		"since it will result in a dependency error from AWS. "+
+		"Instead, it is recommended to use Pulumi autonaming by leaving this property unset (default behavior) "+
+		"or set the `namePrefix` property to allow the provider to autoname the resource.\n")
+
+var fixUpEcsServiceName = targetedSimpleReplace("ecs_service.html.markdown",
+	"* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger "+
+		"an in-place update (redeployment). Useful with `plantimestamp()`. See example above.\n",
+	"* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger "+
+		"an in-place update (redeployment). Useful with `plantimestamp()`. "+
+		"When using the triggers property you also need to set the forceNewDeployment property to True.\n")
+
 func reReplace(from string, to string) tfbridge.DocsEdit {
 	fromR, toB := regexp.MustCompile(from), []byte(to)
 	return tfbridge.DocsEdit{