Package software.amazon.awscdk.services.applicationautoscaling

Class CfnScalableTarget.ScheduledActionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.applicationautoscaling.CfnScalableTarget.ScheduledActionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScalableTarget.ScheduledActionProperty>

Enclosing interface:

CfnScalableTarget.ScheduledActionProperty

@Stability(Stable)
public static final class CfnScalableTarget.ScheduledActionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScalableTarget.ScheduledActionProperty>

A builder for CfnScalableTarget.ScheduledActionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScalableTarget.ScheduledActionProperty	build()	Builds the configured instance.
CfnScalableTarget.ScheduledActionProperty.Builder	endTime(Instant endTime)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getEndTime()
CfnScalableTarget.ScheduledActionProperty.Builder	endTime(IResolvable endTime)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getEndTime()
CfnScalableTarget.ScheduledActionProperty.Builder	scalableTargetAction(IResolvable scalableTargetAction)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getScalableTargetAction()
CfnScalableTarget.ScheduledActionProperty.Builder	scalableTargetAction(CfnScalableTarget.ScalableTargetActionProperty scalableTargetAction)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getScalableTargetAction()
CfnScalableTarget.ScheduledActionProperty.Builder	schedule(String schedule)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getSchedule()
CfnScalableTarget.ScheduledActionProperty.Builder	scheduledActionName(String scheduledActionName)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getScheduledActionName()
CfnScalableTarget.ScheduledActionProperty.Builder	startTime(Instant startTime)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getStartTime()
CfnScalableTarget.ScheduledActionProperty.Builder	startTime(IResolvable startTime)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getStartTime()
CfnScalableTarget.ScheduledActionProperty.Builder	timezone(String timezone)	Sets the value of CfnScalableTarget.ScheduledActionProperty.getTimezone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

schedule

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder schedule(String schedule)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getSchedule()

Parameters:

schedule - The schedule for this action. The following formats are supported:. This parameter is required.

• 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 .

Returns:

this

scheduledActionName

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder scheduledActionName(String scheduledActionName)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getScheduledActionName()

Parameters:

scheduledActionName - The name of the scheduled action. This parameter is required. This name must be unique among all other scheduled actions on the specified scalable target.

Returns:

this

endTime

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder endTime(IResolvable endTime)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getEndTime()

Parameters:

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

Returns:

this

endTime

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder endTime(Instant endTime)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getEndTime()

Parameters:

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

Returns:

this

scalableTargetAction

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder scalableTargetAction(IResolvable scalableTargetAction)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getScalableTargetAction()

Parameters:

scalableTargetAction - 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.

Returns:

this

scalableTargetAction

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder scalableTargetAction(CfnScalableTarget.ScalableTargetActionProperty scalableTargetAction)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getScalableTargetAction()

Parameters:

scalableTargetAction - 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.

Returns:

this

startTime

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder startTime(IResolvable startTime)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getStartTime()

Parameters:

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

Returns:

this

startTime

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder startTime(Instant startTime)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getStartTime()

Parameters:

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

Returns:

this

timezone

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty.Builder timezone(String timezone)

Sets the value of CfnScalableTarget.ScheduledActionProperty.getTimezone()

Parameters:

timezone - 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.

Returns:

this

build

@Stability(Stable)
public CfnScalableTarget.ScheduledActionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScalableTarget.ScheduledActionProperty>

Returns:

a new instance of CfnScalableTarget.ScheduledActionProperty

Throws:

NullPointerException - if any required attribute was not provided