software.amazon.awscdk.services.synthetics

Class CfnCanary.ScheduleProperty.Builder

java.lang.Object

software.amazon.awscdk.services.synthetics.CfnCanary.ScheduleProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCanary.ScheduleProperty>

Enclosing interface:

CfnCanary.ScheduleProperty

@Stability(value=Stable)
public static final class CfnCanary.ScheduleProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCanary.ScheduleProperty>

A builder for CfnCanary.ScheduleProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCanary.ScheduleProperty	build() Builds the configured instance.
CfnCanary.ScheduleProperty.Builder	durationInSeconds(String durationInSeconds) Sets the value of CfnCanary.ScheduleProperty.getDurationInSeconds()
CfnCanary.ScheduleProperty.Builder	expression(String expression) Sets the value of CfnCanary.ScheduleProperty.getExpression()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

expression

@Stability(value=Stable)
public CfnCanary.ScheduleProperty.Builder expression(String expression)

Sets the value of CfnCanary.ScheduleProperty.getExpression()

Parameters:

expression - A `rate` expression or a `cron` expression that defines how often the canary is to run. This parameter is required. 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 .

Returns:

this

durationInSeconds

@Stability(value=Stable)
public CfnCanary.ScheduleProperty.Builder durationInSeconds(String durationInSeconds)

Sets the value of CfnCanary.ScheduleProperty.getDurationInSeconds()

Parameters:

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.

Returns:

this

build

@Stability(value=Stable)
public CfnCanary.ScheduleProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCanary.ScheduleProperty>

Returns:

a new instance of CfnCanary.ScheduleProperty

Throws:

NullPointerException - if any required attribute was not provided