![JAR search and dependency download from the Maven repository](/logo.png)
com.pulumi.awsnative.synthetics.kotlin.inputs.CanaryScheduleArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.synthetics.kotlin.inputs
import com.pulumi.awsnative.synthetics.inputs.CanaryScheduleArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
*
* @property durationInSeconds How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
* @property expression A `rate` expression or a `cron` expression that defines how often the canary is to run.
* For a rate expression, The syntax is `rate( *number unit* )` . *unit* can be `minute` , `minutes` , or `hour` .
* For example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)` .
* Specifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.
* Use `cron( *expression* )` to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .
*/
public data class CanaryScheduleArgs(
public val durationInSeconds: Output? = null,
public val expression: Output,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.synthetics.inputs.CanaryScheduleArgs =
com.pulumi.awsnative.synthetics.inputs.CanaryScheduleArgs.builder()
.durationInSeconds(durationInSeconds?.applyValue({ args0 -> args0 }))
.expression(expression.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [CanaryScheduleArgs].
*/
@PulumiTagMarker
public class CanaryScheduleArgsBuilder internal constructor() {
private var durationInSeconds: Output? = null
private var expression: Output? = null
/**
* @param value How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
*/
@JvmName("qnmienrtvnkngnlh")
public suspend fun durationInSeconds(`value`: Output) {
this.durationInSeconds = value
}
/**
* @param value A `rate` expression or a `cron` expression that defines how often the canary is to run.
* For a rate expression, The syntax is `rate( *number unit* )` . *unit* can be `minute` , `minutes` , or `hour` .
* For example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)` .
* Specifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.
* Use `cron( *expression* )` to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .
*/
@JvmName("mnmtgwtakiptuyuc")
public suspend fun expression(`value`: Output) {
this.expression = value
}
/**
* @param value How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
*/
@JvmName("qptulowhenwlefjv")
public suspend fun durationInSeconds(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.durationInSeconds = mapped
}
/**
* @param value A `rate` expression or a `cron` expression that defines how often the canary is to run.
* For a rate expression, The syntax is `rate( *number unit* )` . *unit* can be `minute` , `minutes` , or `hour` .
* For example, `rate(1 minute)` runs the canary once a minute, `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)` runs it once every hour. You can specify a frequency between `rate(1 minute)` and `rate(1 hour)` .
* Specifying `rate(0 minute)` or `rate(0 hour)` is a special value that causes the canary to run only once when it is started.
* Use `cron( *expression* )` to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see [Scheduling canary runs using cron](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html) .
*/
@JvmName("olmmjqxopxtkwbww")
public suspend fun expression(`value`: String) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.expression = mapped
}
internal fun build(): CanaryScheduleArgs = CanaryScheduleArgs(
durationInSeconds = durationInSeconds,
expression = expression ?: throw PulumiNullFieldException("expression"),
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy