software.amazon.awscdk.services.autoscaling

Interface BasicScheduledActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ScheduledActionProps

All Known Implementing Classes:

BasicScheduledActionProps.Jsii$Proxy, ScheduledActionProps.Jsii$Proxy

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

Properties for a scheduled scaling action.

Example:

 AutoScalingGroup autoScalingGroup;
 autoScalingGroup.scaleOnSchedule("PrescaleInTheMorning", BasicScheduledActionProps.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("8").minute("0").build()))
         .minCapacity(20)
         .build());
 autoScalingGroup.scaleOnSchedule("AllowDownscalingAtNight", BasicScheduledActionProps.builder()
         .schedule(Schedule.cron(CronOptions.builder().hour("20").minute("0").build()))
         .minCapacity(1)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BasicScheduledActionProps.Builder A builder for BasicScheduledActionProps
static class	BasicScheduledActionProps.Jsii$Proxy An implementation for BasicScheduledActionProps

Method Summary

Modifier and Type	Method and Description
static BasicScheduledActionProps.Builder	builder()
default Number	getDesiredCapacity() The new desired capacity.
default Instant	getEndTime() When this scheduled action expires.
default Number	getMaxCapacity() The new maximum capacity.
default Number	getMinCapacity() The new minimum capacity.
Schedule	getSchedule() When to perform this action.
default Instant	getStartTime() When this scheduled action becomes active.
default String	getTimeZone() Specifies the time zone for a cron expression.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSchedule

@Stability(value=Stable)
 @NotNull
Schedule getSchedule()

When to perform this action.

Supports cron expressions.

For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.

getDesiredCapacity

@Stability(value=Stable)
 @Nullable
default Number getDesiredCapacity()

The new desired capacity.

At the scheduled time, set the desired capacity to the given capacity.

At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.

Default: - No new desired capacity.

getEndTime

@Stability(value=Stable)
 @Nullable
default Instant getEndTime()

When this scheduled action expires.

Default: - The rule never expires.

getMaxCapacity

@Stability(value=Stable)
 @Nullable
default Number getMaxCapacity()

The new maximum capacity.

At the scheduled time, set the maximum capacity to the given capacity.

At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.

Default: - No new maximum capacity.

getMinCapacity

@Stability(value=Stable)
 @Nullable
default Number getMinCapacity()

The new minimum capacity.

At the scheduled time, set the minimum capacity to the given capacity.

At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.

Default: - No new minimum capacity.

getStartTime

@Stability(value=Stable)
 @Nullable
default Instant getStartTime()

When this scheduled action becomes active.

Default: - The rule is activate immediately.

getTimeZone

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

Specifies the time zone for a cron expression.

If a time zone is not provided, UTC is used by default.

Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti).

For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Default: - UTC

builder

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

Returns:

a BasicScheduledActionProps.Builder of BasicScheduledActionProps