Synthetics Update: This release introduces two features. The first is tag replication, which allows for the propagation of canary tags onto Synthetics related resources, such as Lambda functions. The second is a limit increase in canary name length, which has now been increased from 21 to 255 characters.

AWS · AWS · commit 51a56b35714d · 2024-09-12T18:09:52.000Z
diff --git a/.changes/next-release/feature-Synthetics-a91cf87.json b/.changes/next-release/feature-Synthetics-a91cf87.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Synthetics",
+    "contributor": "",
+    "description": "This release introduces two features. The first is tag replication, which allows for the propagation of canary tags onto Synthetics related resources, such as Lambda functions. The second is a limit increase in canary name length, which has now been increased from 21 to 255 characters."
+}
diff --git a/services/synthetics/src/main/resources/codegen-resources/endpoint-rule-set.json b/services/synthetics/src/main/resources/codegen-resources/endpoint-rule-set.json
@@ -40,7 +40,6 @@
                     ]
                 }
             ],
-            "type": "tree",
             "rules": [
                 {
                     "conditions": [
@@ -83,7 +82,8 @@
                     },
                     "type": "endpoint"
                 }
-            ]
+            ],
+            "type": "tree"
         },
         {
             "conditions": [
@@ -96,7 +96,6 @@
                     ]
                 }
             ],
-            "type": "tree",
             "rules": [
                 {
                     "conditions": [
@@ -110,7 +109,6 @@
                             "assign": "PartitionResult"
                         }
                     ],
-                    "type": "tree",
                     "rules": [
                         {
                             "conditions": [
@@ -133,7 +131,6 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
@@ -168,7 +165,6 @@
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -179,14 +175,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [
@@ -200,14 +198,12 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
                                         {
                                             "fn": "booleanEquals",
                                             "argv": [
-                                                true,
                                                 {
                                                     "fn": "getAttr",
                                                     "argv": [
@@ -216,11 +212,11 @@
                                                         },
                                                         "supportsFIPS"
                                                     ]
-                                                }
+                                                },
+                                                true
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -231,14 +227,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "FIPS is enabled but this partition does not support FIPS",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [
@@ -252,7 +250,6 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
@@ -272,7 +269,6 @@
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -283,14 +279,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "DualStack is enabled but this partition does not support DualStack",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [],
@@ -301,9 +299,11 @@
                             },
                             "type": "endpoint"
                         }
-                    ]
+                    ],
+                    "type": "tree"
                 }
-            ]
+            ],
+            "type": "tree"
         },
         {
             "conditions": [],
diff --git a/services/synthetics/src/main/resources/codegen-resources/service-2.json b/services/synthetics/src/main/resources/codegen-resources/service-2.json
@@ -5,12 +5,14 @@
     "endpointPrefix":"synthetics",
     "jsonVersion":"1.1",
     "protocol":"rest-json",
+    "protocols":["rest-json"],
     "serviceAbbreviation":"Synthetics",
     "serviceFullName":"Synthetics",
     "serviceId":"synthetics",
     "signatureVersion":"v4",
     "signingName":"synthetics",
-    "uid":"synthetics-2017-10-11"
+    "uid":"synthetics-2017-10-11",
+    "auth":["aws.auth#sigv4"]
   },
   "operations":{
     "AssociateResource":{
@@ -75,7 +77,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"ConflictException"}
       ],
-      "documentation":"<p>Permanently deletes the specified canary.</p> <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.</p> <p>Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:</p> <ul> <li> <p>The CloudWatch alarms created for this canary. These alarms have a name of <code>Synthetics-SharpDrop-Alarm-<i>MyCanaryName</i> </code>.</p> </li> <li> <p>Amazon S3 objects and buckets, such as the canary's artifact location.</p> </li> <li> <p>IAM roles created for the canary. If they were created in the console, these roles have the name <code> role/service-role/CloudWatchSyntheticsRole-<i>MyCanaryName</i> </code>.</p> </li> <li> <p>CloudWatch Logs log groups created for the canary. These logs groups have the name <code>/aws/lambda/cwsyn-<i>MyCanaryName</i> </code>. </p> </li> </ul> <p>Before you delete a canary, you might want to use <code>GetCanary</code> to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.</p>"
+      "documentation":"<p>Permanently deletes the specified canary.</p> <p>If you specify <code>DeleteLambda</code> to <code>true</code>, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.</p> <p>Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:</p> <ul> <li> <p>The CloudWatch alarms created for this canary. These alarms have a name of <code>Synthetics-Alarm-<i>first-198-characters-of-canary-name</i>-<i>canaryId</i>-<i>alarm number</i> </code> </p> </li> <li> <p>Amazon S3 objects and buckets, such as the canary's artifact location.</p> </li> <li> <p>IAM roles created for the canary. If they were created in the console, these roles have the name <code> role/service-role/CloudWatchSyntheticsRole-<i>First-21-Characters-of-CanaryName</i> </code> </p> </li> <li> <p>CloudWatch Logs log groups created for the canary. These logs groups have the name <code>/aws/lambda/cwsyn-<i>First-21-Characters-of-CanaryName</i> </code> </p> </li> </ul> <p>Before you delete a canary, you might want to use <code>GetCanary</code> to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.</p>"
     },
     "DeleteGroup":{
       "name":"DeleteGroup",
@@ -507,7 +509,7 @@
       "type":"string",
       "max":2048,
       "min":1,
-      "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,21}"
+      "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,255}"
     },
     "CanaryCodeInput":{
       "type":"structure",
@@ -534,7 +536,7 @@
           "documentation":"<p>The entry point to use for the source code when running the canary. For canaries that use the <code>syn-python-selenium-1.0</code> runtime or a <code>syn-nodejs.puppeteer</code> runtime earlier than <code>syn-nodejs.puppeteer-3.4</code>, the handler must be specified as <code> <i>fileName</i>.handler</code>. For <code>syn-python-selenium-1.1</code>, <code>syn-nodejs.puppeteer-3.4</code>, and later runtimes, the handler can be specified as <code> <i>fileName</i>.<i>functionName</i> </code>, or you can specify a folder where canary scripts reside as <code> <i>folder</i>/<i>fileName</i>.<i>functionName</i> </code>.</p>"
         }
       },
-      "documentation":"<p>Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of <code>Zipfile</code>. </p>"
+      "documentation":"<p>Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of <code>Zipfile</code>. </p> <p>If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.</p> <ul> <li> <p>For Node.js canaries, the folder structure must be <code>nodejs/node_modules/<i>myCanaryFilename.js</i> </code> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package\">Packaging your Node.js canary files</a> </p> </li> <li> <p>For Python canaries, the folder structure must be <code>python/<i>myCanaryFilename.p</i> </code> or <code>python/<i>myFolder/myCanaryFilename.py</i> </code> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package\">Packaging your Python canary files</a> </p> </li> </ul>"
     },
     "CanaryCodeOutput":{
       "type":"structure",
@@ -566,7 +568,7 @@
     },
     "CanaryName":{
       "type":"string",
-      "max":21,
+      "max":255,
       "min":1,
       "pattern":"^[0-9a-z_\\-]+$"
     },
@@ -853,9 +855,13 @@
           "shape":"VpcConfigInput",
           "documentation":"<p>If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html\"> Running a Canary in a VPC</a>.</p>"
         },
+        "ResourcesToReplicateTags":{
+          "shape":"ResourceList",
+          "documentation":"<p>To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value <code>lambda-function</code>.</p> <p>If you specify this parameter and don't specify any tags in the <code>Tags</code> parameter, the canary creation fails.</p>"
+        },
         "Tags":{
           "shape":"TagMap",
-          "documentation":"<p>A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.</p>"
+          "documentation":"<p>A list of key-value pairs to associate with the canary. You can associate as many as 50 tags with a canary.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.</p> <p>To have the tags that you apply to this canary also be applied to the Lambda function that the canary uses, specify this parameter with the value <code>lambda-function</code>.</p>"
         },
         "ArtifactConfig":{
           "shape":"ArtifactConfigInput",
@@ -986,7 +992,7 @@
         },
         "MaxResults":{
           "shape":"MaxCanaryResults",
-          "documentation":"<p>Specify this parameter to limit how many canaries are returned each time you use the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 100 is used.</p>"
+          "documentation":"<p>Specify this parameter to limit how many canaries are returned each time you use the <code>DescribeCanaries</code> operation. If you omit this parameter, the default of 20 is used.</p>"
         },
         "Names":{
           "shape":"DescribeCanariesNameFilter",
@@ -1427,6 +1433,12 @@
       "min":1,
       "pattern":"arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:(canary|group):[0-9a-z_\\-]+"
     },
+    "ResourceList":{
+      "type":"list",
+      "member":{"shape":"ResourceToTag"},
+      "max":1,
+      "min":1
+    },
     "ResourceNotFoundException":{
       "type":"structure",
       "members":{
@@ -1436,6 +1448,10 @@
       "error":{"httpStatusCode":404},
       "exception":true
     },
+    "ResourceToTag":{
+      "type":"string",
+      "enum":["lambda-function"]
+    },
     "RoleArn":{
       "type":"string",
       "max":2048,

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@`
`40`	`40`	`]`
`41`	`41`	`}`
`42`	`42`	`],`
`43`		`- "type": "tree",`
`44`	`43`	`"rules": [`
`45`	`44`	`{`
`46`	`45`	`"conditions": [`
`@@ -83,7 +82,8 @@`
`83`	`82`	`},`
`84`	`83`	`"type": "endpoint"`
`85`	`84`	`}`
`86`		`- ]`
	`85`	`+ ],`
	`86`	`+ "type": "tree"`
`87`	`87`	`},`
`88`	`88`	`{`
`89`	`89`	`"conditions": [`
`@@ -96,7 +96,6 @@`
`96`	`96`	`]`
`97`	`97`	`}`
`98`	`98`	`],`
`99`		`- "type": "tree",`
`100`	`99`	`"rules": [`
`101`	`100`	`{`
`102`	`101`	`"conditions": [`
`@@ -110,7 +109,6 @@`
`110`	`109`	`"assign": "PartitionResult"`
`111`	`110`	`}`
`112`	`111`	`],`
`113`		`- "type": "tree",`
`114`	`112`	`"rules": [`
`115`	`113`	`{`
`116`	`114`	`"conditions": [`
`@@ -133,7 +131,6 @@`
`133`	`131`	`]`
`134`	`132`	`}`
`135`	`133`	`],`
`136`		`- "type": "tree",`
`137`	`134`	`"rules": [`
`138`	`135`	`{`
`139`	`136`	`"conditions": [`
`@@ -168,7 +165,6 @@`
`168`	`165`	`]`
`169`	`166`	`}`
`170`	`167`	`],`
`171`		`- "type": "tree",`
`172`	`168`	`"rules": [`
`173`	`169`	`{`
`174`	`170`	`"conditions": [],`
`@@ -179,14 +175,16 @@`
`179`	`175`	`},`
`180`	`176`	`"type": "endpoint"`
`181`	`177`	`}`
`182`		`- ]`
	`178`	`+ ],`
	`179`	`+ "type": "tree"`
`183`	`180`	`},`
`184`	`181`	`{`
`185`	`182`	`"conditions": [],`
`186`	`183`	`"error": "FIPS and DualStack are enabled, but this partition does not support one or both",`
`187`	`184`	`"type": "error"`
`188`	`185`	`}`
`189`		`- ]`
	`186`	`+ ],`
	`187`	`+ "type": "tree"`
`190`	`188`	`},`
`191`	`189`	`{`
`192`	`190`	`"conditions": [`
`@@ -200,14 +198,12 @@`
`200`	`198`	`]`
`201`	`199`	`}`
`202`	`200`	`],`
`203`		`- "type": "tree",`
`204`	`201`	`"rules": [`
`205`	`202`	`{`
`206`	`203`	`"conditions": [`
`207`	`204`	`{`
`208`	`205`	`"fn": "booleanEquals",`
`209`	`206`	`"argv": [`
`210`		`- true,`
`211`	`207`	`{`
`212`	`208`	`"fn": "getAttr",`
`213`	`209`	`"argv": [`
`@@ -216,11 +212,11 @@`
`216`	`212`	`},`
`217`	`213`	`"supportsFIPS"`
`218`	`214`	`]`
`219`		`- }`
	`215`	`+ },`
	`216`	`+ true`
`220`	`217`	`]`
`221`	`218`	`}`
`222`	`219`	`],`
`223`		`- "type": "tree",`
`224`	`220`	`"rules": [`
`225`	`221`	`{`
`226`	`222`	`"conditions": [],`
`@@ -231,14 +227,16 @@`
`231`	`227`	`},`
`232`	`228`	`"type": "endpoint"`
`233`	`229`	`}`
`234`		`- ]`
	`230`	`+ ],`
	`231`	`+ "type": "tree"`
`235`	`232`	`},`
`236`	`233`	`{`
`237`	`234`	`"conditions": [],`
`238`	`235`	`"error": "FIPS is enabled but this partition does not support FIPS",`
`239`	`236`	`"type": "error"`
`240`	`237`	`}`
`241`		`- ]`
	`238`	`+ ],`
	`239`	`+ "type": "tree"`
`242`	`240`	`},`
`243`	`241`	`{`
`244`	`242`	`"conditions": [`
`@@ -252,7 +250,6 @@`
`252`	`250`	`]`
`253`	`251`	`}`
`254`	`252`	`],`
`255`		`- "type": "tree",`
`256`	`253`	`"rules": [`
`257`	`254`	`{`
`258`	`255`	`"conditions": [`
`@@ -272,7 +269,6 @@`
`272`	`269`	`]`
`273`	`270`	`}`
`274`	`271`	`],`
`275`		`- "type": "tree",`
`276`	`272`	`"rules": [`
`277`	`273`	`{`
`278`	`274`	`"conditions": [],`
`@@ -283,14 +279,16 @@`
`283`	`279`	`},`
`284`	`280`	`"type": "endpoint"`
`285`	`281`	`}`
`286`		`- ]`
	`282`	`+ ],`
	`283`	`+ "type": "tree"`
`287`	`284`	`},`
`288`	`285`	`{`
`289`	`286`	`"conditions": [],`
`290`	`287`	`"error": "DualStack is enabled but this partition does not support DualStack",`
`291`	`288`	`"type": "error"`
`292`	`289`	`}`
`293`		`- ]`
	`290`	`+ ],`
	`291`	`+ "type": "tree"`
`294`	`292`	`},`
`295`	`293`	`{`
`296`	`294`	`"conditions": [],`
`@@ -301,9 +299,11 @@`
`301`	`299`	`},`
`302`	`300`	`"type": "endpoint"`
`303`	`301`	`}`
`304`		`- ]`
	`302`	`+ ],`
	`303`	`+ "type": "tree"`
`305`	`304`	`}`
`306`		`- ]`
	`305`	`+ ],`
	`306`	`+ "type": "tree"`
`307`	`307`	`},`
`308`	`308`	`{`
`309`	`309`	`"conditions": [],`