Class BasicScheduledActionProps

Properties for a scheduled scaling action.

Inheritance

System.Object

BasicScheduledActionProps

Implements

IBasicScheduledActionProps

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public class BasicScheduledActionProps : Object, IBasicScheduledActionProps

Syntax (vb)

Public Class BasicScheduledActionProps
    Inherits Object
    Implements IBasicScheduledActionProps

Remarks

ExampleMetadata: infused

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
});

Synopsis

Constructors

BasicScheduledActionProps()

Properties

DesiredCapacity	The new desired capacity.
EndTime	When this scheduled action expires.
MaxCapacity	The new maximum capacity.
MinCapacity	The new minimum capacity.
Schedule	When to perform this action.
StartTime	When this scheduled action becomes active.
TimeZone	Specifies the time zone for a cron expression.

Constructors

BasicScheduledActionProps()

public BasicScheduledActionProps()

Properties

DesiredCapacity

The new desired capacity.

public Nullable<double> DesiredCapacity { get; set; }

Property Value

System.Nullable<System.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 Nullable<DateTime> EndTime { get; set; }

Property Value

System.Nullable<System.DateTime>

Remarks

Default: - The rule never expires.

MaxCapacity

The new maximum capacity.

public Nullable<double> MaxCapacity { get; set; }

Property Value

System.Nullable<System.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 Nullable<double> MinCapacity { get; set; }

Property Value

System.Nullable<System.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 Nullable<DateTime> StartTime { get; set; }

Property Value

System.Nullable<System.DateTime>

Remarks

Default: - The rule is activate immediately.

TimeZone

Specifies the time zone for a cron expression.

public string TimeZone { get; set; }

Property Value

System.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

Implements

IBasicScheduledActionProps