synthetics/aws.sdk.kotlin.services.synthetics.model/CanaryRunConfigInput

CanaryRunConfigInput

class CanaryRunConfigInput

A structure that contains input information for a canary run.

Types

Builder

class Builder

Companion

object Companion

Properties

activeTracing

val activeTracing: Boolean?

Specifies whether this canary is to use active X-Ray tracing when it runs. Active tracing enables this canary run to be displayed in the ServiceLens and X-Ray service maps even if the canary does not hit an endpoint that has X-Ray tracing enabled. Using X-Ray tracing incurs charges. For more information, see Canaries and X-Ray tracing.

environmentVariables

val environmentVariables: Map<String, String>?

Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:

ephemeralStorage

val ephemeralStorage: Int?

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

memoryInMb

val memoryInMb: Int?

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

timeoutInSeconds

val timeoutInSeconds: Int?

How long the canary is allowed to run before it must stop. You can't set this time to be longer than the frequency of the runs of this canary.

Functions

copy

inline fun copy(block: CanaryRunConfigInput.Builder.() -> Unit = {}): CanaryRunConfigInput

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String