aws synthetics create-canary

Creates a canary. AWS CLI reference

17 options Its page in the AWS CLI reference

Options

17 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-configsCloudWatch Synthetics now supports multibrowser canaries for syn-nodejs-puppeteer-11.0 and syn-nodejs-playwright-3.0 runtimes.

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

--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 for this canary.

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

--resources-to-replicate-tagsTo 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 lambda-function.

--run-configA structure that contains the configuration for individual canary runs, such as timeout value and environment variables.

--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 test runs are to stop.

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

--tagsA list of key-value pairs to associate with the canary.

--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.