Interface IBasicScheduledActionProps

Properties for a scheduled scaling action.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBasicScheduledActionProps

Syntax (vb)

Public Interface 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

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.

Properties

DesiredCapacity

The new desired capacity.

virtual Nullable<double> DesiredCapacity { get; }

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.

virtual Nullable<DateTime> EndTime { get; }

Property Value

System.Nullable<System.DateTime>

Remarks

Default: - The rule never expires.

MaxCapacity

The new maximum capacity.

virtual Nullable<double> MaxCapacity { get; }

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.

virtual Nullable<double> MinCapacity { get; }

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.

Schedule Schedule { get; }

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.

virtual Nullable<DateTime> StartTime { get; }

Property Value

System.Nullable<System.DateTime>

Remarks

Default: - The rule is activate immediately.

TimeZone

Specifies the time zone for a cron expression.

virtual string TimeZone { get; }

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