software.amazon.awscdk.services.autoscaling

Class ScheduledActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.ScheduledActionProps.Builder

Enclosing interface:

ScheduledActionProps

public static final class ScheduledActionProps.Builder
extends java.lang.Object

A builder for ScheduledActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Builder

public Builder()

Method Detail

autoScalingGroup

public ScheduledActionProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of ScheduledActionProps.getAutoScalingGroup()

Parameters:

autoScalingGroup - The AutoScalingGroup to apply the scheduled actions to. This parameter is required.

Returns:

this

schedule

public ScheduledActionProps.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

public ScheduledActionProps.Builder desiredCapacity(java.lang.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

public ScheduledActionProps.Builder endTime(java.time.Instant endTime)

Sets the value of BasicScheduledActionProps.getEndTime()

Parameters:

endTime - When this scheduled action expires.

Returns:

this

maxCapacity

public ScheduledActionProps.Builder maxCapacity(java.lang.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

public ScheduledActionProps.Builder minCapacity(java.lang.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

public ScheduledActionProps.Builder startTime(java.time.Instant startTime)

Sets the value of BasicScheduledActionProps.getStartTime()

Parameters:

startTime - When this scheduled action becomes active.

Returns:

this

timeZone

public ScheduledActionProps.Builder timeZone(java.lang.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

public ScheduledActionProps build()

Builds the configured instance.

Returns:

a new instance of ScheduledActionProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided