Package software.amazon.awscdk.services.autoscaling

Interface CfnScheduledActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.682Z")
@Stability(Stable)
public interface CfnScheduledActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnScheduledAction.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 CfnScheduledActionProps cfnScheduledActionProps = CfnScheduledActionProps.builder()
         .autoScalingGroupName("autoScalingGroupName")
         // the properties below are optional
         .desiredCapacity(123)
         .endTime("endTime")
         .maxSize(123)
         .minSize(123)
         .recurrence("recurrence")
         .startTime("startTime")
         .timeZone("timeZone")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScheduledActionProps.Builder	A builder for CfnScheduledActionProps
static final class	CfnScheduledActionProps.Jsii$Proxy	An implementation for CfnScheduledActionProps

Method Summary

Modifier and Type	Method	Description
static CfnScheduledActionProps.Builder	builder()
String	getAutoScalingGroupName()	The name of the Auto Scaling group.
default Number	getDesiredCapacity()	The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
default String	getEndTime()	The date and time for the recurring schedule to end, in UTC.
default Number	getMaxSize()	The maximum size of the Auto Scaling group.
default Number	getMinSize()	The minimum size of the Auto Scaling group.
default String	getRecurrence()	The recurring schedule for this action.
default String	getStartTime()	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" ).
default String	getTimeZone()	Specifies the time zone for a cron expression.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingGroupName

@Stability(Stable)
@NotNull
String getAutoScalingGroupName()

The name of the Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-autoscalinggroupname

getDesiredCapacity

@Stability(Stable)
@Nullable
default Number getDesiredCapacity()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-desiredcapacity

getEndTime

@Stability(Stable)
@Nullable
default String getEndTime()

The date and time for the recurring schedule to end, in UTC.

For example, "2021-06-01T00:00:00Z" .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-endtime

getMaxSize

@Stability(Stable)
@Nullable
default Number getMaxSize()

The maximum size of the Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-maxsize

getMinSize

@Stability(Stable)
@Nullable
default Number getMinSize()

The minimum size of the Auto Scaling group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-minsize

getRecurrence

@Stability(Stable)
@Nullable
default String getRecurrence()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-recurrence

getStartTime

@Stability(Stable)
@Nullable
default String getStartTime()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-starttime

getTimeZone

@Stability(Stable)
@Nullable
default String getTimeZone()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-scheduledaction.html#cfn-autoscaling-scheduledaction-timezone

builder

@Stability(Stable)
static CfnScheduledActionProps.Builder builder()

Returns:

a CfnScheduledActionProps.Builder of CfnScheduledActionProps