Skip to content

Commit 7de1ff2

Browse files
author
AWS
committed
Synthetics Update: Adds support to configure canaries with pre-configured blueprint code on supported runtime versions. This behavior can be controlled via the new BlueprintTypes property exposed in the CreateCanary and UpdateCanary APIs.
1 parent e62c15f commit 7de1ff2

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Synthetics",
4+
"contributor": "",
5+
"description": "Adds support to configure canaries with pre-configured blueprint code on supported runtime versions. This behavior can be controlled via the new BlueprintTypes property exposed in the CreateCanary and UpdateCanary APIs."
6+
}

services/synthetics/src/main/resources/codegen-resources/service-2.json

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,18 @@
458458
"max":10000000,
459459
"min":1
460460
},
461+
"BlueprintType":{
462+
"type":"string",
463+
"max":128,
464+
"min":1,
465+
"pattern":"[0-9a-zA-Z_\\-\\.]+"
466+
},
467+
"BlueprintTypes":{
468+
"type":"list",
469+
"member":{"shape":"BlueprintType"},
470+
"max":1,
471+
"min":0
472+
},
461473
"BrowserConfig":{
462474
"type":"structure",
463475
"members":{
@@ -582,7 +594,6 @@
582594
},
583595
"CanaryCodeInput":{
584596
"type":"structure",
585-
"required":["Handler"],
586597
"members":{
587598
"S3Bucket":{
588599
"shape":"String",
@@ -602,7 +613,11 @@
602613
},
603614
"Handler":{
604615
"shape":"CodeHandler",
605-
"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>"
616+
"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> <p>This field is required when you don't specify <code>BlueprintTypes</code> and is not allowed when you specify <code>BlueprintTypes</code>.</p>"
617+
},
618+
"BlueprintTypes":{
619+
"shape":"BlueprintTypes",
620+
"documentation":"<p> <code>BlueprintTypes</code> is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is <code>multi-checks</code>.</p> <p>Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify <code>BlueprintTypes</code>, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.</p> <p> <code>BlueprintTypes</code> is supported only on canaries for syn-nodejs-3.0 runtime or later.</p>"
606621
},
607622
"Dependencies":{
608623
"shape":"Dependencies",
@@ -620,7 +635,11 @@
620635
},
621636
"Handler":{
622637
"shape":"String",
623-
"documentation":"<p>The entry point to use for the source code when running the canary.</p>"
638+
"documentation":"<p>The entry point to use for the source code when running the canary.</p> <p>This field is required when you don't specify <code>BlueprintTypes</code> and is not allowed when you specify <code>BlueprintTypes</code>.</p>"
639+
},
640+
"BlueprintTypes":{
641+
"shape":"BlueprintTypes",
642+
"documentation":"<p> <code>BlueprintTypes</code> is a list of templates that enable simplified canary creation. You can create canaries for common monitoring scenarios by providing only a JSON configuration file instead of writing custom scripts. The only supported value is <code>multi-checks</code>.</p> <p>Multi-checks monitors HTTP/DNS/SSL/TCP endpoints with built-in authentication schemes (Basic, API Key, OAuth, SigV4) and assertion capabilities. When you specify <code>BlueprintTypes</code>, the Handler field cannot be specified since the blueprint provides a pre-defined entry point.</p> <p> <code>BlueprintTypes</code> is supported only on canaries for syn-nodejs-3.0 runtime or later.</p>"
624643
},
625644
"Dependencies":{
626645
"shape":"Dependencies",
@@ -927,8 +946,8 @@
927946
"CodeHandler":{
928947
"type":"string",
929948
"max":128,
930-
"min":1,
931-
"pattern":"^([0-9a-zA-Z_-]+(\\/|\\.))*[0-9A-Za-z_\\\\-]+(\\.|::)[A-Za-z_][A-Za-z0-9_]*$"
949+
"min":0,
950+
"pattern":"^(([0-9a-zA-Z_-]+(\\/|\\.))*[0-9A-Za-z_\\\\-]+(\\.|::)[A-Za-z_][A-Za-z0-9_]*)?$"
932951
},
933952
"ConflictException":{
934953
"type":"structure",

0 commit comments

Comments
 (0)