GetCanaryResult

data class GetCanaryResult(val artifactConfig: CanaryArtifactConfig? = null, val artifactS3Location: String? = null, val code: CanaryCode? = null, val executionRoleArn: String? = null, val failureRetentionPeriod: Int? = null, val id: String? = null, val provisionedResourceCleanup: CanaryProvisionedResourceCleanup? = null, val runConfig: CanaryRunConfig? = null, val runtimeVersion: String? = null, val schedule: CanarySchedule? = null, val state: String? = null, val successRetentionPeriod: Int? = null, val tags: List<Tag>? = null, val vpcConfig: CanaryVpcConfig? = null)

Constructors

Link copied to clipboard
constructor(artifactConfig: CanaryArtifactConfig? = null, artifactS3Location: String? = null, code: CanaryCode? = null, executionRoleArn: String? = null, failureRetentionPeriod: Int? = null, id: String? = null, provisionedResourceCleanup: CanaryProvisionedResourceCleanup? = null, runConfig: CanaryRunConfig? = null, runtimeVersion: String? = null, schedule: CanarySchedule? = null, state: String? = null, successRetentionPeriod: Int? = null, tags: List<Tag>? = null, vpcConfig: CanaryVpcConfig? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Provide artifact configuration

Link copied to clipboard

Provide the s3 bucket output location for test results

Link copied to clipboard
val code: CanaryCode? = null

Provide the canary script source

Link copied to clipboard

Lambda Execution role used to run your canaries

Link copied to clipboard

Retention period of failed canary runs represented in number of days

Link copied to clipboard
val id: String? = null

Id of the canary

Link copied to clipboard

Setting to control if provisioned resources created by Synthetics are deleted alongside the canary. Default is AUTOMATIC.

Link copied to clipboard

Provide canary run configuration

Link copied to clipboard
val runtimeVersion: String? = null

Runtime version of Synthetics Library

Link copied to clipboard

Frequency to run your canaries

Link copied to clipboard
val state: String? = null

State of the canary

Link copied to clipboard

Retention period of successful canary runs represented in number of days

Link copied to clipboard
val tags: List<Tag>? = null

The list of key-value pairs that are associated with the canary.

Link copied to clipboard

Provide VPC Configuration if enabled.