software.amazon.awscdk.services.autoscaling

Class CfnScheduledActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnScheduledActionProps.Builder

Enclosing interface:

CfnScheduledActionProps

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

A builder for CfnScheduledActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnScheduledActionProps.Builder	autoScalingGroupName(java.lang.String autoScalingGroupName) Sets the value of CfnScheduledActionProps.getAutoScalingGroupName()
CfnScheduledActionProps	build() Builds the configured instance.
CfnScheduledActionProps.Builder	desiredCapacity(java.lang.Number desiredCapacity) Sets the value of CfnScheduledActionProps.getDesiredCapacity()
CfnScheduledActionProps.Builder	endTime(java.lang.String endTime) Sets the value of CfnScheduledActionProps.getEndTime()
CfnScheduledActionProps.Builder	maxSize(java.lang.Number maxSize) Sets the value of CfnScheduledActionProps.getMaxSize()
CfnScheduledActionProps.Builder	minSize(java.lang.Number minSize) Sets the value of CfnScheduledActionProps.getMinSize()
CfnScheduledActionProps.Builder	recurrence(java.lang.String recurrence) Sets the value of CfnScheduledActionProps.getRecurrence()
CfnScheduledActionProps.Builder	startTime(java.lang.String startTime) Sets the value of CfnScheduledActionProps.getStartTime()
CfnScheduledActionProps.Builder	timeZone(java.lang.String timeZone) Sets the value of CfnScheduledActionProps.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

autoScalingGroupName

public CfnScheduledActionProps.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)

Sets the value of CfnScheduledActionProps.getAutoScalingGroupName()

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

desiredCapacity

public CfnScheduledActionProps.Builder desiredCapacity(java.lang.Number desiredCapacity)

Sets the value of CfnScheduledActionProps.getDesiredCapacity()

Parameters:

desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.

You must specify at least one of the following properties: MaxSize , MinSize , or DesiredCapacity .

Returns:

this

endTime

public CfnScheduledActionProps.Builder endTime(java.lang.String endTime)

Sets the value of CfnScheduledActionProps.getEndTime()

Parameters:

endTime - The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z" .

Returns:

this

maxSize

public CfnScheduledActionProps.Builder maxSize(java.lang.Number maxSize)

Sets the value of CfnScheduledActionProps.getMaxSize()

Parameters:

maxSize - The maximum size of the Auto Scaling group.

Returns:

this

minSize

public CfnScheduledActionProps.Builder minSize(java.lang.Number minSize)

Sets the value of CfnScheduledActionProps.getMinSize()

Parameters:

minSize - The minimum size of the Auto Scaling group.

Returns:

this

recurrence

public CfnScheduledActionProps.Builder recurrence(java.lang.String recurrence)

Sets the value of CfnScheduledActionProps.getRecurrence()

Parameters:

recurrence - The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *" ). For more information about this format, see Crontab .

When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.

Cron expressions use Universal Coordinated Time (UTC) by default.

Returns:

this

startTime

public CfnScheduledActionProps.Builder startTime(java.lang.String startTime)

Sets the value of CfnScheduledActionProps.getStartTime()

Parameters:

startTime - The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, `"2021-06-01T00:00:00Z"` ). If you specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

Returns:

this

timeZone

public CfnScheduledActionProps.Builder timeZone(java.lang.String timeZone)

Sets the value of CfnScheduledActionProps.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 CfnScheduledActionProps build()

Builds the configured instance.

Returns:

a new instance of CfnScheduledActionProps

Throws:

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