Class CfnScheduledActionProps.Builder
java.lang.Object
software.amazon.awscdk.services.autoscaling.CfnScheduledActionProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScheduledActionProps>
- Enclosing interface:
CfnScheduledActionProps
@Stability(Stable)
public static final class CfnScheduledActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScheduledActionProps>
A builder for
CfnScheduledActionProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoScalingGroupName
(String autoScalingGroupName) Sets the value ofCfnScheduledActionProps.getAutoScalingGroupName()
build()
Builds the configured instance.desiredCapacity
(Number desiredCapacity) Sets the value ofCfnScheduledActionProps.getDesiredCapacity()
Sets the value ofCfnScheduledActionProps.getEndTime()
Sets the value ofCfnScheduledActionProps.getMaxSize()
Sets the value ofCfnScheduledActionProps.getMinSize()
recurrence
(String recurrence) Sets the value ofCfnScheduledActionProps.getRecurrence()
Sets the value ofCfnScheduledActionProps.getStartTime()
Sets the value ofCfnScheduledActionProps.getTimeZone()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
autoScalingGroupName
@Stability(Stable) public CfnScheduledActionProps.Builder autoScalingGroupName(String autoScalingGroupName) Sets the value ofCfnScheduledActionProps.getAutoScalingGroupName()
- Parameters:
autoScalingGroupName
- The name of the Auto Scaling group. This parameter is required.- Returns:
this
-
desiredCapacity
Sets the value ofCfnScheduledActionProps.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
, orDesiredCapacity
.- Returns:
this
-
endTime
Sets the value ofCfnScheduledActionProps.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
Sets the value ofCfnScheduledActionProps.getMaxSize()
- Parameters:
maxSize
- The maximum size of the Auto Scaling group.- Returns:
this
-
minSize
Sets the value ofCfnScheduledActionProps.getMinSize()
- Parameters:
minSize
- The minimum size of the Auto Scaling group.- Returns:
this
-
recurrence
Sets the value ofCfnScheduledActionProps.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
andEndTime
are specified withRecurrence
, they form the boundaries of when the recurring action starts and stops.Cron expressions use Universal Coordinated Time (UTC) by default.
- Returns:
this
-
startTime
Sets the value ofCfnScheduledActionProps.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 specifyRecurrence
andStartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.- Returns:
this
-
timeZone
Sets the value ofCfnScheduledActionProps.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
orPacific/Tahiti
). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones .- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnScheduledActionProps>
- Returns:
- a new instance of
CfnScheduledActionProps
- Throws:
NullPointerException
- if any required attribute was not provided
-