synthetics/aws.sdk.kotlin.services.synthetics.model/Canary/Builder

Builder

Properties

var artifactConfig: ArtifactConfigOutput?

A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.

artifactS3Location

var artifactS3Location: String?

The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary. Artifacts include the log file, screenshots, and HAR files.

var code: CanaryCodeOutput?

This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.

var engineArn: String?

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.

executionRoleArn

var executionRoleArn: String?

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.

failureRetentionPeriodInDays

var failureRetentionPeriodInDays: Int?

The number of days to retain data about failed runs of this canary.

var id: String?

The unique ID of this canary.

var name: String?

The name of the canary.

var runConfig: CanaryRunConfigOutput?

A structure that contains information about a canary run.

var runtimeVersion: String?

Specifies the runtime version to use for the canary. For more information about runtime versions, see Canary Runtime Versions.

var schedule: CanaryScheduleOutput?

A structure that contains information about how often the canary is to run, and when these runs are to stop.

var status: CanaryStatus?

A structure that contains information about the canary's status.

successRetentionPeriodInDays

var successRetentionPeriodInDays: Int?

The number of days to retain data about successful runs of this canary.

var tags: Map<String, String>?

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

var timeline: CanaryTimeline?

A structure that contains information about when the canary was created, modified, and most recently run.

visualReference

var visualReference: VisualReferenceOutput?

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.

var vpcConfig: VpcConfigOutput?

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.

Functions

fun artifactConfig(block: ArtifactConfigOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.ArtifactConfigOutput inside the given block

fun code(block: CanaryCodeOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryCodeOutput inside the given block

fun runConfig(block: CanaryRunConfigOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryRunConfigOutput inside the given block

fun schedule(block: CanaryScheduleOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryScheduleOutput inside the given block

fun status(block: CanaryStatus.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryStatus inside the given block

fun timeline(block: CanaryTimeline.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.CanaryTimeline inside the given block

visualReference

fun visualReference(block: VisualReferenceOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.VisualReferenceOutput inside the given block

fun vpcConfig(block: VpcConfigOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.synthetics.model.VpcConfigOutput inside the given block