software.amazon.awscdk.services.applicationautoscaling

Interface CronOptions

All Known Implementing Classes:

CronOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:57.957Z")
public interface CronOptions

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

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

Method Detail

getDay

default java.lang.String getDay()

The day of the month to run this rule at.

Default: - Every day of the month

getHour

default java.lang.String getHour()

The hour to run this rule at.

Default: - Every hour

getMinute

default java.lang.String getMinute()

The minute to run this rule at.

Default: - Every minute

getMonth

default java.lang.String getMonth()

The month to run this rule at.

Default: - Every month

getWeekDay

default java.lang.String getWeekDay()

The day of the week to run this rule at.

Default: - Any day of the week

getYear

default java.lang.String getYear()

The year to run this rule at.

Default: - Every year

builder

static CronOptions.Builder builder()

Returns:

a CronOptions.Builder of CronOptions