Skip to content

Commit 3004def

Browse files
author
AWS
committed
Synthetics Update: CloudWatch Synthetics now enables customers to choose a customer managed AWS KMS key or an Amazon S3-managed key instead of an AWS managed key (default) for the encryption of artifacts that the canary stores in Amazon S3. CloudWatch Synthetics also supports artifact S3 location updation now.
1 parent fa00f90 commit 3004def

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Synthetics",
4+
"contributor": "",
5+
"description": "CloudWatch Synthetics now enables customers to choose a customer managed AWS KMS key or an Amazon S3-managed key instead of an AWS managed key (default) for the encryption of artifacts that the canary stores in Amazon S3. CloudWatch Synthetics also supports artifact S3 location updation now."
6+
}

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

+63
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,26 @@
209209
}
210210
},
211211
"shapes":{
212+
"ArtifactConfigInput":{
213+
"type":"structure",
214+
"members":{
215+
"S3Encryption":{
216+
"shape":"S3EncryptionConfig",
217+
"documentation":"<p>A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3. Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html\">Encrypting canary artifacts</a> </p>"
218+
}
219+
},
220+
"documentation":"<p>A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>"
221+
},
222+
"ArtifactConfigOutput":{
223+
"type":"structure",
224+
"members":{
225+
"S3Encryption":{
226+
"shape":"S3EncryptionConfig",
227+
"documentation":"<p>A structure that contains the configuration of encryption settings for canary artifacts that are stored in Amazon S3. </p>"
228+
}
229+
},
230+
"documentation":"<p>A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>"
231+
},
212232
"BaseScreenshot":{
213233
"type":"structure",
214234
"required":["ScreenshotName"],
@@ -308,6 +328,10 @@
308328
"Tags":{
309329
"shape":"TagMap",
310330
"documentation":"<p>The list of key-value pairs that are associated with the canary.</p>"
331+
},
332+
"ArtifactConfig":{
333+
"shape":"ArtifactConfigOutput",
334+
"documentation":"<p>A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>"
311335
}
312336
},
313337
"documentation":"<p>This structure contains all information about one canary in your account.</p>"
@@ -646,6 +670,10 @@
646670
"Tags":{
647671
"shape":"TagMap",
648672
"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>"
673+
},
674+
"ArtifactConfig":{
675+
"shape":"ArtifactConfigInput",
676+
"documentation":"<p>A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>"
649677
}
650678
}
651679
},
@@ -753,6 +781,13 @@
753781
}
754782
}
755783
},
784+
"EncryptionMode":{
785+
"type":"string",
786+
"enum":[
787+
"SSE_S3",
788+
"SSE_KMS"
789+
]
790+
},
756791
"EnvironmentVariableName":{
757792
"type":"string",
758793
"pattern":"[a-zA-Z]([a-zA-Z0-9_])+"
@@ -833,6 +868,12 @@
833868
"error":{"httpStatusCode":500},
834869
"exception":true
835870
},
871+
"KmsKeyArn":{
872+
"type":"string",
873+
"max":2048,
874+
"min":1,
875+
"pattern":"arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:key/[\\w\\-\\/]+"
876+
},
836877
"ListTagsForResourceRequest":{
837878
"type":"structure",
838879
"required":["ResourceArn"],
@@ -926,6 +967,20 @@
926967
"type":"list",
927968
"member":{"shape":"RuntimeVersion"}
928969
},
970+
"S3EncryptionConfig":{
971+
"type":"structure",
972+
"members":{
973+
"EncryptionMode":{
974+
"shape":"EncryptionMode",
975+
"documentation":"<p> The encryption method to use for artifacts created by this canary. Specify <code>SSE_S3</code> to use server-side encryption (SSE) with an Amazon S3-managed key. Specify <code>SSE-KMS</code> to use server-side encryption with a customer-managed KMS key.</p> <p>If you omit this parameter, an Amazon Web Services-managed KMS key is used. </p>"
976+
},
977+
"KmsKeyArn":{
978+
"shape":"KmsKeyArn",
979+
"documentation":"<p>The ARN of the customer-managed KMS key to use, if you specify <code>SSE-KMS</code> for <code>EncryptionMode</code> </p>"
980+
}
981+
},
982+
"documentation":"<p>A structure that contains the configuration of encryption-at-rest settings for canary artifacts that the canary uploads to Amazon S3. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html\">Encrypting canary artifacts</a> </p>"
983+
},
929984
"SecurityGroupId":{"type":"string"},
930985
"SecurityGroupIds":{
931986
"type":"list",
@@ -1107,6 +1162,14 @@
11071162
"VisualReference":{
11081163
"shape":"VisualReferenceInput",
11091164
"documentation":"<p>Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.</p> <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b> runtime or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html\"> Visual monitoring</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html\"> Visual monitoring blueprint</a> </p>"
1165+
},
1166+
"ArtifactS3Location":{
1167+
"shape":"String",
1168+
"documentation":"<p>The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).</p>"
1169+
},
1170+
"ArtifactConfig":{
1171+
"shape":"ArtifactConfigInput",
1172+
"documentation":"<p>A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>"
11101173
}
11111174
}
11121175
},

0 commit comments

Comments
 (0)