software.amazon.awscdk.services.applicationautoscaling

Interface CfnScalableTarget.ScheduledActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScalableTarget.ScheduledActionProperty.Jsii$Proxy

Enclosing class:

CfnScalableTarget

@Stability(value=Stable)
public static interface CfnScalableTarget.ScheduledActionProperty
extends software.amazon.jsii.JsiiSerializable

`ScheduledAction` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target.

For more information, see PutScheduledAction in the Application Auto Scaling API Reference . For more information about scheduled scaling, including the format for cron expressions, see Scheduled scaling in the Application Auto Scaling User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationautoscaling.*;
 ScheduledActionProperty scheduledActionProperty = ScheduledActionProperty.builder()
         .schedule("schedule")
         .scheduledActionName("scheduledActionName")
         // the properties below are optional
         .endTime(new Date())
         .scalableTargetAction(ScalableTargetActionProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .build())
         .startTime(new Date())
         .timezone("timezone")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnScalableTarget.ScheduledActionProperty.Builder	builder()
default Object	getEndTime() The date and time that the action is scheduled to end, in UTC.
default Object	getScalableTargetAction() The new minimum and maximum capacity.
String	getSchedule() The schedule for this action.
String	getScheduledActionName() The name of the scheduled action.
default Object	getStartTime() The date and time that the action is scheduled to begin, in UTC.
default String	getTimezone() The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSchedule

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

The schedule for this action. The following formats are supported:.

• At expressions - " at( *yyyy* - *mm* - *dd* T *hh* : *mm* : *ss* ) "
• Rate expressions - " rate( *value* *unit* ) "
• Cron expressions - " cron( *fields* ) "

At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

At and cron expressions use Universal Coordinated Time (UTC) by default.

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .

getScheduledActionName

@Stability(value=Stable)
 @NotNull
String getScheduledActionName()

The name of the scheduled action.

This name must be unique among all other scheduled actions on the specified scalable target.

getEndTime

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

The date and time that the action is scheduled to end, in UTC.

getScalableTargetAction

@Stability(value=Stable)
 @Nullable
default Object getScalableTargetAction()

The new minimum and maximum capacity.

You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

getStartTime

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

The date and time that the action is scheduled to begin, in UTC.

getTimezone

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

The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

builder

@Stability(value=Stable)
static CfnScalableTarget.ScheduledActionProperty.Builder builder()

Returns:

a CfnScalableTarget.ScheduledActionProperty.Builder of CfnScalableTarget.ScheduledActionProperty