software.amazon.awscdk.services.autoscaling

Class ScheduledAction.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.ScheduledAction.Builder

Enclosing class:

ScheduledAction

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

A fluent builder for ScheduledAction.

Method Summary

Modifier and Type	Method and Description
ScheduledAction.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) The AutoScalingGroup to apply the scheduled actions to.
ScheduledAction	build()
static ScheduledAction.Builder	create(software.constructs.Construct scope, java.lang.String id)
ScheduledAction.Builder	desiredCapacity(java.lang.Number desiredCapacity) The new desired capacity.
ScheduledAction.Builder	endTime(java.time.Instant endTime) When this scheduled action expires.
ScheduledAction.Builder	maxCapacity(java.lang.Number maxCapacity) The new maximum capacity.
ScheduledAction.Builder	minCapacity(java.lang.Number minCapacity) The new minimum capacity.
ScheduledAction.Builder	schedule(Schedule schedule) When to perform this action.
ScheduledAction.Builder	startTime(java.time.Instant startTime) When this scheduled action becomes active.
ScheduledAction.Builder	timeZone(java.lang.String timeZone) Specifies the time zone for a cron expression.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ScheduledAction.Builder create(software.constructs.Construct scope,
                                             java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ScheduledAction.Builder.

schedule

public ScheduledAction.Builder schedule(Schedule schedule)

When to perform this action.

Supports cron expressions.

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

Parameters:

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

Returns:

this

desiredCapacity

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

Default: - No new desired capacity.

Parameters:

desiredCapacity - The new desired capacity. This parameter is required.

Returns:

this

endTime

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

When this scheduled action expires.

Default: - The rule never expires.

Parameters:

endTime - When this scheduled action expires. This parameter is required.

Returns:

this

maxCapacity

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

Default: - No new maximum capacity.

Parameters:

maxCapacity - The new maximum capacity. This parameter is required.

Returns:

this

minCapacity

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

Default: - No new minimum capacity.

Parameters:

minCapacity - The new minimum capacity. This parameter is required.

Returns:

this

startTime

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

When this scheduled action becomes active.

Default: - The rule is activate immediately.

Parameters:

startTime - When this scheduled action becomes active. This parameter is required.

Returns:

this

timeZone

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

Default: - UTC

Parameters:

timeZone - Specifies the time zone for a cron expression. This parameter is required.

Returns:

this

autoScalingGroup

public ScheduledAction.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

The AutoScalingGroup to apply the scheduled actions to.

Parameters:

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

Returns:

this

build

public ScheduledAction build()