aws synthetics update-canary

Updates the configuration of a canary that has already been created. AWS CLI reference

19 options Its page in the AWS CLI reference

Options

19 in the AWS CLI reference

--add-replica-locationsA list of locations (Amazon Web Services Regions) to add as replicas for the canary.

--artifact-configA structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

--artifact-s3-locationThe location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary.

--browser-configsA structure that specifies the browser type to use for a canary run.

--codeA structure that includes the entry point from which the canary should start running your script.

--dry-run-idUpdate the existing canary using the updated configurations from the DryRun associated with the DryRunId.

--execution-role-arnThe ARN of the IAM role to be used to run the canary.

--failure-retention-period-in-daysThe number of days to retain data about failed runs of this canary.

--kms-key-arnThe Amazon Resource Name (ARN) of the customer-managed AWS Key Management Service (AWS KMS) key used to encrypt the canary's AWS Lambda function environment variables at rest.

--nameThe name of the canary that you want to update.

--provisioned-resource-cleanupSpecifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.

--remove-replica-locationsA list of locations (Amazon Web Services Regions) to remove as replicas for the canary.

--run-configA structure that contains the timeout value that is used for each individual run of the canary.

--runtime-versionSpecifies the runtime version to use for the canary.

--scheduleA structure that contains information about how often the canary is to run, and when these runs are to stop.

--success-retention-period-in-daysThe number of days to retain data about successful runs of this canary.

--visual-referenceDefines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary.

--visual-referencesA list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on.

--vpc-configIf this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint.