Canary
This structure contains all information about one canary in your account.
Contents
- ArtifactConfig
-
A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
Type: ArtifactConfigOutput object
Required: No
- ArtifactS3Location
-
The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- Code
-
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
Type: CanaryCodeOutput object
Required: No
- EngineArn
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?Required: No
- ExecutionRoleArn
-
The ARN of the IAM role used to run the canary. This role must include
lambda.amazonaws.comas a principal in the trust policy.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+Required: No
- FailureRetentionPeriodInDays
-
The number of days to retain data about failed runs of this canary.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1024.
Required: No
- Id
-
The unique ID of this canary.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: No
- Name
-
The name of the canary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 21.
Pattern:
^[0-9a-z_\-]+$Required: No
- RunConfig
-
A structure that contains information about a canary run.
Type: CanaryRunConfigOutput object
Required: No
- RuntimeVersion
-
Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- Schedule
-
A structure that contains information about how often the canary is to run, and when these runs are to stop.
Type: CanaryScheduleOutput object
Required: No
- Status
-
A structure that contains information about the canary's status.
Type: CanaryStatus object
Required: No
- SuccessRetentionPeriodInDays
-
The number of days to retain data about successful runs of this canary.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1024.
Required: No
- Tags
-
The list of key-value pairs that are associated with the canary.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Required: No
- Timeline
-
A structure that contains information about when the canary was created, modified, and most recently run.
Type: CanaryTimeline object
Required: No
- VisualReference
-
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.
Type: VisualReferenceOutput object
Required: No
- VpcConfig
-
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.
Type: VpcConfigOutput object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
