Table of Contents

Class CfnScheduledActionProps

Namespace
Amazon.CDK.AWS.AutoScaling
Assembly
Amazon.CDK.AWS.AutoScaling.dll

Properties for defining a CfnScheduledAction.

public class CfnScheduledActionProps : ICfnScheduledActionProps
Inheritance
CfnScheduledActionProps
Implements
Inherited Members

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AutoScaling;

             var cfnScheduledActionProps = new CfnScheduledActionProps {
                 AutoScalingGroupName = "autoScalingGroupName",

                 // the properties below are optional
                 DesiredCapacity = 123,
                 EndTime = "endTime",
                 MaxSize = 123,
                 MinSize = 123,
                 Recurrence = "recurrence",
                 StartTime = "startTime",
                 TimeZone = "timeZone"
             };

Remarks

Constructors

CfnScheduledActionProps()

public CfnScheduledActionProps()

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

public string AutoScalingGroupName { get; set; }

Property Value

string

Remarks

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.

public double? DesiredCapacity { get; set; }

Property Value

double?

Remarks

It can scale beyond this capacity if you add more scaling conditions.

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

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

EndTime

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

public string? EndTime { get; set; }

Property Value

string

Remarks

MaxSize

The maximum size of the Auto Scaling group.

public double? MaxSize { get; set; }

Property Value

double?

Remarks

MinSize

The minimum size of the Auto Scaling group.

public double? MinSize { get; set; }

Property Value

double?

Remarks

Recurrence

The recurring schedule for this action.

public string? Recurrence { get; set; }

Property Value

string

Remarks

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.

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

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" ).

public string? StartTime { get; set; }

Property Value

string

Remarks

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.

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

TimeZone

Specifies the time zone for a cron expression.

public string? TimeZone { get; set; }

Property Value

string

Remarks

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 .

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