Package software.amazon.awscdk.services.autoscaling

Class BasicScheduledActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.BasicScheduledActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BasicScheduledActionProps>

Enclosing interface:

BasicScheduledActionProps

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

A builder for BasicScheduledActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BasicScheduledActionProps	build()	Builds the configured instance.
BasicScheduledActionProps.Builder	desiredCapacity(Number desiredCapacity)	Sets the value of BasicScheduledActionProps.getDesiredCapacity()
BasicScheduledActionProps.Builder	endTime(Instant endTime)	Sets the value of BasicScheduledActionProps.getEndTime()
BasicScheduledActionProps.Builder	maxCapacity(Number maxCapacity)	Sets the value of BasicScheduledActionProps.getMaxCapacity()
BasicScheduledActionProps.Builder	minCapacity(Number minCapacity)	Sets the value of BasicScheduledActionProps.getMinCapacity()
BasicScheduledActionProps.Builder	schedule(Schedule schedule)	Sets the value of BasicScheduledActionProps.getSchedule()
BasicScheduledActionProps.Builder	startTime(Instant startTime)	Sets the value of BasicScheduledActionProps.getStartTime()
BasicScheduledActionProps.Builder	timeZone(String timeZone)	Sets the value of BasicScheduledActionProps.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 BasicScheduledActionProps.Builder schedule(Schedule schedule)

Sets the value of BasicScheduledActionProps.getSchedule()

Parameters:

schedule - When to perform this action. This parameter is required. Supports cron expressions.

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

Returns:

this

desiredCapacity

@Stability(Stable)
public BasicScheduledActionProps.Builder desiredCapacity(Number desiredCapacity)

Sets the value of BasicScheduledActionProps.getDesiredCapacity()

Parameters:

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

Returns:

this

endTime

@Stability(Stable)
public BasicScheduledActionProps.Builder endTime(Instant endTime)

Sets the value of BasicScheduledActionProps.getEndTime()

Parameters:

endTime - When this scheduled action expires. Warning! You should not set this field! After the scheduled end time, the AutoScaling service will delete the ScheduledAction without CloudFormation's knowledge, and subsequent stack deployments that try to modify or delete this ScheduledAction will fail.

Returns:

this

maxCapacity

@Stability(Stable)
public BasicScheduledActionProps.Builder maxCapacity(Number maxCapacity)

Sets the value of BasicScheduledActionProps.getMaxCapacity()

Parameters:

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

Returns:

this

minCapacity

@Stability(Stable)
public BasicScheduledActionProps.Builder minCapacity(Number minCapacity)

Sets the value of BasicScheduledActionProps.getMinCapacity()

Parameters:

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

Returns:

this

startTime

@Stability(Stable)
public BasicScheduledActionProps.Builder startTime(Instant startTime)

Sets the value of BasicScheduledActionProps.getStartTime()

Parameters:

startTime - When this scheduled action becomes active.

Returns:

this

timeZone

@Stability(Stable)
public BasicScheduledActionProps.Builder timeZone(String timeZone)

Sets the value of BasicScheduledActionProps.getTimeZone()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public BasicScheduledActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BasicScheduledActionProps>

Returns:

a new instance of BasicScheduledActionProps

Throws:

NullPointerException - if any required attribute was not provided