class Aws::Synthetics::Types::Canary
This structure contains all information about one canary in your account.
@!attribute [rw] id
The unique ID of this canary. @return [String]
@!attribute [rw] name
The name of the canary. @return [String]
@!attribute [rw] code
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics. @return [Types::CanaryCodeOutput]
@!attribute [rw] execution_role_arn
The ARN of the IAM role used to run the canary. This role must include `lambda.amazonaws.com` as a principal in the trust policy. @return [String]
@!attribute [rw] schedule
A structure that contains information about how often the canary is to run, and when these runs are to stop. @return [Types::CanaryScheduleOutput]
@!attribute [rw] run_config
A structure that contains information about a canary run. @return [Types::CanaryRunConfigOutput]
@!attribute [rw] success_retention_period_in_days
The number of days to retain data about successful runs of this canary. @return [Integer]
@!attribute [rw] failure_retention_period_in_days
The number of days to retain data about failed runs of this canary. @return [Integer]
@!attribute [rw] status
A structure that contains information about the canary's status. @return [Types::CanaryStatus]
@!attribute [rw] timeline
A structure that contains information about when the canary was created, modified, and most recently run. @return [Types::CanaryTimeline]
@!attribute [rw] artifact_s3_location
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files. @return [String]
@!attribute [rw] engine_arn
The ARN of the Lambda function that is used as your canary's engine. For more information about Lambda ARN format, see [Resources and Conditions for Lambda Actions][1]. [1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-api-permissions-ref.html @return [String]
@!attribute [rw] runtime_version
Specifies the runtime version to use for the canary. For more information about runtime versions, see [ Canary Runtime Versions][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html @return [String]
@!attribute [rw] vpc_config
If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see [ Running a Canary in a VPC][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html @return [Types::VpcConfigOutput]
@!attribute [rw] visual_reference
If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates of any parts of the screen to ignore during the visual monitoring comparison. @return [Types::VisualReferenceOutput]
@!attribute [rw] tags
The list of key-value pairs that are associated with the canary. @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/Canary AWS API Documentation
Constants
- SENSITIVE