Resource Type definition for AWS::Synthetics::Canary
artifact_s3_location
(String) Provide the s3 bucket output location for test resultscode
(Attributes) Provide the canary script source (see below for nested schema)execution_role_arn
(String) Lambda Execution role used to run your canariesname
(String) Name of the canary.runtime_version
(String) Runtime version of Synthetics Libraryschedule
(Attributes) Frequency to run your canaries (see below for nested schema)artifact_config
(Attributes) Provide artifact configuration (see below for nested schema)delete_lambda_resources_on_canary_deletion
(Boolean) Deletes associated lambda resources created by Synthetics if set to True. Default is Falsefailure_retention_period
(Number) Retention period of failed canary runs represented in number of daysrun_config
(Attributes) Provide canary run configuration (see below for nested schema)start_canary_after_creation
(Boolean) Runs canary if set to True. Default is Falsesuccess_retention_period
(Number) Retention period of successful canary runs represented in number of daystags
(Attributes List) (see below for nested schema)visual_reference
(Attributes) Visual reference configuration for visual testing (see below for nested schema)vpc_config
(Attributes) Provide VPC Configuration if enabled. (see below for nested schema)canary_id
(String) Id of the canaryid
(String) Uniquely identifies the resource.state
(String) State of the canarycode
Required:
handler
(String)Optional:
s3_bucket
(String)s3_key
(String)s3_object_version
(String)script
(String)Read-Only:
source_location_arn
(String)schedule
Required:
expression
(String)Optional:
duration_in_seconds
(String)artifact_config
Optional:
s3_encryption
(Attributes) Encryption configuration for uploading artifacts to S3 (see below for nested schema)artifact_config.s3_encryption
Optional:
encryption_mode
(String) Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.kms_key_arn
(String) KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.run_config
Optional:
active_tracing
(Boolean) Enable active tracing if set to trueenvironment_variables
(Map of String) Environment variable key-value pairs.memory_in_mb
(Number) Provide maximum memory available for canary in MBtimeout_in_seconds
(Number) Provide maximum canary timeout per run in secondstags
Required:
key
(String) The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.value
(String) The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.visual_reference
Required:
base_canary_run_id
(String) Canary run id to be used as base reference for visual testingOptional:
base_screenshots
(Attributes List) List of screenshots used as base reference for visual testing (see below for nested schema)visual_reference.base_screenshots
Required:
screenshot_name
(String) Name of the screenshot to be used as base reference for visual testingOptional:
ignore_coordinates
(List of String) List of coordinates of rectangles to be ignored during visual testingvpc_config
Required:
security_group_ids
(List of String)subnet_ids
(List of String)Optional:
vpc_id
(String)Import is supported using the following syntax:
$ terraform import awscc_synthetics_canary.example <resource ID>