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 (.).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Amazon.PowerShell.Cmdlets.CWSYN.AmazonSyntheticsClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName, or you can specify a folder where canary scripts reside as folder/fileName.functionName.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If your canary script is located in S3, specify the bucket name here. Do not include s3:// as the start of the bucket name.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The S3 version ID of your script.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The ARN of the IAM role to be used to run the canary. This role must already exist, and must include
lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
- s3:PutObject
- s3:GetBucketLocation
- s3:ListAllMyBuckets
- cloudwatch:PutMetricData
- logs:CreateLogGroup
- logs:CreateLogStream
- logs:CreateLogStream
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-FailureRetentionPeriodInDay <
Int32>
The number of days to retain data about failed runs of this canary.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | FailureRetentionPeriodInDays |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the canary that you want to update. To find the names of your canaries, use
DescribeCanaries.You cannot change the name of a canary that has already been created.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see
Canaries and X-Ray tracing.You can enable active tracing only for canaries that use version
syn-nodejs-2.0 or later for their canary runtime.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:{ "key1" : "value1", "key2" : "value2", ...}Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see
Runtime environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RunConfig_EnvironmentVariables |
-RunConfig_MemoryInMB <
Int32>
The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-RunConfig_TimeoutInSecond <
Int32>
How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.If you omit this field, the frequency of the canary is used as this value, up to a maximum of 14 minutes.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RunConfig_TimeoutInSeconds |
Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see
Canary Runtime Versions.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.If you omit this parameter, an Amazon Web Services-managed KMS key is used.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ArtifactConfig_S3Encryption_EncryptionMode |
-S3Encryption_KmsKeyArn <
String>
The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ArtifactConfig_S3Encryption_KmsKeyArn |
-Schedule_DurationInSecond <Int64>
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Schedule_DurationInSeconds |
A
rate expression or a
cron expression that defines how often the canary is to run.For a rate expression, The syntax is
rate(number unit).
unit can be
minute,
minutes, or
hour. For example,
rate(1 minute) runs the canary once a minute,
rate(10 minutes) runs it once every 10 minutes, and
rate(1 hour) runs it once every hour. You can specify a frequency between
rate(1 minute) and
rate(1 hour).Specifying
rate(0 minute) or
rate(0 hour) is a special value that causes the canary to run only once when it is started.Use
cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see
Scheduling canary runs using cron.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Synthetics.Model.UpdateCanaryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SuccessRetentionPeriodInDay <
Int32>
The number of days to retain data about successful runs of this canary.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SuccessRetentionPeriodInDays |
-VisualReference_BaseCanaryRunId <
String>
Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are
nextrun to use the screenshots from the next run after this update is made,
lastrun to use the screenshots from the most recent run before this update was made, or the value of
Id in the
CanaryRun from any past run of this canary.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VisualReference_BaseScreenshots |
The IDs of the security groups for this canary.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_SecurityGroupIds |
The IDs of the subnets where this canary is to run.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_SubnetIds |