CronOptions (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CronOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.410Z")
 @Stability(value=Stable)
public interface CronOptions
extends software.amazon.jsii.JsiiSerializable

Options to configure a cron expression.

All fields are strings so you can use complex expressions. Absence of a field implies '*' or '?', whichever one is appropriate.

Example:

 Cluster cluster;
 ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 ScalableTaskCount scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount(EnableScalingProps.builder()
         .minCapacity(5)
         .maxCapacity(20)
         .build());
 scalableTarget.scaleOnSchedule("DaytimeScaleDown", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
         .minCapacity(1)
         .build());
 scalableTarget.scaleOnSchedule("EveningRushScaleUp", ScalingSchedule.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("20").minute("0").build()))
         .minCapacity(10)
         .build());

See Also:: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CronOptions.Builder` A builder for `CronOptions`
`static class`	`CronOptions.Jsii$Proxy` An implementation for `CronOptions`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CronOptions.Builder`	`builder()`
`default String`	`getDay()` The day of the month to run this rule at.
`default String`	`getHour()` The hour to run this rule at.
`default String`	`getMinute()` The minute to run this rule at.
`default String`	`getMonth()` The month to run this rule at.
`default String`	`getWeekDay()` The day of the week to run this rule at.
`default String`	`getYear()` The year to run this rule at.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Detail

getDay
```
@Stability(value=Stable)
 @Nullable
default String getDay()
```
The day of the month to run this rule at.
Default: - Every day of the month

getHour

@Stability(value=Stable)
 @Nullable
default String getHour()

The hour to run this rule at.

Default: - Every hour

getMinute

@Stability(value=Stable)
 @Nullable
default String getMinute()

The minute to run this rule at.

Default: - Every minute

getMonth

@Stability(value=Stable)
 @Nullable
default String getMonth()

The month to run this rule at.

Default: - Every month

getWeekDay
```
@Stability(value=Stable)
 @Nullable
default String getWeekDay()
```
The day of the week to run this rule at.
Default: - Any day of the week

getYear

@Stability(value=Stable)
 @Nullable
default String getYear()

The year to run this rule at.

Default: - Every year

builder

@Stability(value=Stable)
static CronOptions.Builder builder()

Returns:: a CronOptions.Builder of CronOptions

Interface CronOptions