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.29.0 (build 41df200)",
           date="2021-06-02T09:55:01.096Z")
 @Stability(value=Experimental)
public interface BasicScheduledActionProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a scheduled scaling action.

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() (experimental) The new desired capacity.
default Instant	getEndTime() (experimental) When this scheduled action expires.
default Number	getMaxCapacity() (experimental) The new maximum capacity.
default Number	getMinCapacity() (experimental) The new minimum capacity.
Schedule	getSchedule() (experimental) When to perform this action.
default Instant	getStartTime() (experimental) When this scheduled action becomes active.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSchedule

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

(experimental) When to perform this action.

Supports cron expressions.

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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 0;8 * * ?;

getDesiredCapacity

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

(experimental) 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=Experimental)
 @Nullable
default Instant getEndTime()

(experimental) When this scheduled action expires.

Default: - The rule never expires.

getMaxCapacity

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

(experimental) 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=Experimental)
 @Nullable
default Number getMinCapacity()

(experimental) 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=Experimental)
 @Nullable
default Instant getStartTime()

(experimental) When this scheduled action becomes active.

Default: - The rule is activate immediately.

builder

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

Returns:

a BasicScheduledActionProps.Builder of BasicScheduledActionProps