Class BasicScheduledActionProps

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

Properties for a scheduled scaling action.

public class BasicScheduledActionProps : IBasicScheduledActionProps

Inheritance

object

BasicScheduledActionProps

Implements

IBasicScheduledActionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

AutoScalingGroup autoScalingGroup;


            autoScalingGroup.ScaleOnSchedule("PrescaleInTheMorning", new BasicScheduledActionProps {
                Schedule = Schedule.Cron(new CronOptions { Hour = "8", Minute = "0" }),
                MinCapacity = 20
            });

            autoScalingGroup.ScaleOnSchedule("AllowDownscalingAtNight", new BasicScheduledActionProps {
                Schedule = Schedule.Cron(new CronOptions { Hour = "20", Minute = "0" }),
                MinCapacity = 1
            });

Remarks

ExampleMetadata: infused

Constructors

BasicScheduledActionProps()

public BasicScheduledActionProps()

Properties

DesiredCapacity

The new desired capacity.

public double? DesiredCapacity { get; set; }

Property Value

double?

Remarks

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.

EndTime

When this scheduled action expires.

public DateTime? EndTime { get; set; }

Property Value

DateTime?

Remarks

Default: - The rule never expires.

MaxCapacity

The new maximum capacity.

public double? MaxCapacity { get; set; }

Property Value

double?

Remarks

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.

MinCapacity

The new minimum capacity.

public double? MinCapacity { get; set; }

Property Value

double?

Remarks

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.

Schedule

When to perform this action.

public Schedule Schedule { get; set; }

Property Value

Schedule

Remarks

Supports cron expressions.

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

StartTime

When this scheduled action becomes active.

public DateTime? StartTime { get; set; }

Property Value

DateTime?

Remarks

Default: - The rule is activate immediately.

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.

Default: - UTC