Package software.amazon.awscdk.services.synthetics

Class Schedule

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.synthetics.Schedule
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:38.243Z") @Stability(Stable) public class Schedule extends software.amazon.jsii.JsiiObject
Schedule for canary runs.

Example: 

 Canary canary = Canary.Builder.create(this, "MyCanary")
         .schedule(Schedule.rate(Duration.minutes(5)))
         .test(Test.custom(CustomTestOptions.builder()
                 .code(Code.fromAsset(join(__dirname, "canary")))
                 .handler("index.handler")
                 .build()))
         .runtime(Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2)
         .environmentVariables(Map.of(
                 "stage", "prod"))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Schedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Schedule(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Schedule
    cron(CronOptions options)
    Create a schedule from a set of cron fields.
    static Schedule
    expression(String expression)
    Construct a schedule from a literal schedule expression.
    String
    getExpressionString()
    The Schedule expression.
    static Schedule
    once()
    The canary will be executed once.
    static Schedule
    rate(Duration interval)
    Construct a schedule from an interval.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Schedule

      protected Schedule(software.amazon.jsii.JsiiObjectRef objRef)

    • Schedule

      protected Schedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • cron

      @Stability(Stable) @NotNull public static Schedule cron(@NotNull CronOptions options)
      Create a schedule from a set of cron fields.

      Parameters:
      options - This parameter is required.

    • expression

      @Stability(Stable) @NotNull public static Schedule expression(@NotNull String expression)
      Construct a schedule from a literal schedule expression.

      The expression must be in a rate(number units) format. For example, Schedule.expression('rate(10 minutes)')

      Parameters:
      expression - The expression to use. This parameter is required.

    • once

      @Stability(Stable) @NotNull public static Schedule once()
      The canary will be executed once.

    • rate

      @Stability(Stable) @NotNull public static Schedule rate(@NotNull Duration interval)
      Construct a schedule from an interval.

      Allowed values: 0 (for a single run) or between 1 and 60 minutes. To specify a single run, you can use Schedule.once().

      Parameters:
      interval - The interval at which to run the canary. This parameter is required.

    • getExpressionString

      @Stability(Stable) @NotNull public String getExpressionString()
      The Schedule expression.