Class CfnScalableTarget.ScheduledActionProperty
ScheduledAction
is a property of the AWS::ApplicationAutoScaling::ScalableTarget resource that specifies a scheduled action for a scalable target.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ApplicationAutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ScheduledActionProperty : Object, CfnScalableTarget.IScheduledActionProperty
Syntax (vb)
Public Class ScheduledActionProperty
Inherits Object
Implements CfnScalableTarget.IScheduledActionProperty
Remarks
For more information, see Scheduled scaling in the Application Auto Scaling User Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ApplicationAutoScaling;
var scheduledActionProperty = new ScheduledActionProperty {
Schedule = "schedule",
ScheduledActionName = "scheduledActionName",
// the properties below are optional
EndTime = new Date(),
ScalableTargetAction = new ScalableTargetActionProperty {
MaxCapacity = 123,
MinCapacity = 123
},
StartTime = new Date(),
Timezone = "timezone"
};
Synopsis
Constructors
ScheduledActionProperty() |
Properties
EndTime | The date and time that the action is scheduled to end, in UTC. |
ScalableTargetAction | The new minimum and maximum capacity. |
Schedule | The schedule for this action. The following formats are supported:. |
ScheduledActionName | The name of the scheduled action. |
StartTime | The date and time that the action is scheduled to begin, in UTC. |
Timezone | The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. |
Constructors
ScheduledActionProperty()
public ScheduledActionProperty()
Properties
EndTime
The date and time that the action is scheduled to end, in UTC.
public object EndTime { get; set; }
Property Value
System.Object
Remarks
ScalableTargetAction
The new minimum and maximum capacity.
public object ScalableTargetAction { get; set; }
Property Value
System.Object
Remarks
You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
Schedule
The schedule for this action. The following formats are supported:.
public string Schedule { get; set; }
Property Value
System.String
Remarks
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute
| minutes
| hour
| hours
| day
| days
.
ScheduledActionName
The name of the scheduled action.
public string ScheduledActionName { get; set; }
Property Value
System.String
Remarks
This name must be unique among all other scheduled actions on the specified scalable target.
StartTime
The date and time that the action is scheduled to begin, in UTC.
public object StartTime { get; set; }
Property Value
System.Object
Remarks
Timezone
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
public string Timezone { get; set; }
Property Value
System.String