Interface ICfnScheduledActionProps

Properties for defining a CfnScheduledAction.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface ICfnScheduledActionProps

Syntax (vb)

Public Interface ICfnScheduledActionProps

Remarks

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

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.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"
};

Synopsis

Properties

AutoScalingGroupName	The name of the Auto Scaling group.
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.
EndTime	The date and time for the recurring schedule to end, in UTC.
MaxSize	The maximum size of the Auto Scaling group.
MinSize	The minimum size of the Auto Scaling group.
Recurrence	The recurring schedule for this action.
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" ).
TimeZone	Specifies the time zone for a cron expression.

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

string AutoScalingGroupName { get; }

Property Value

System.String

Remarks

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

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.

virtual Nullable<double> DesiredCapacity { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

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

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.

virtual string EndTime { get; }

Property Value

System.String

Remarks

For example, "2021-06-01T00:00:00Z" .

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

MaxSize

The maximum size of the Auto Scaling group.

virtual Nullable<double> MaxSize { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

MinSize

The minimum size of the Auto Scaling group.

virtual Nullable<double> MinSize { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

Recurrence

The recurring schedule for this action.

virtual string Recurrence { get; }

Property Value

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

virtual string StartTime { get; }

Property Value

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

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 .

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