1.204.0

interface CfnScheduledActionProps

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.CfnScheduledActionProps
Javasoftware.amazon.awscdk.services.autoscaling.CfnScheduledActionProps
Pythonaws_cdk.aws_autoscaling.CfnScheduledActionProps
TypeScript @aws-cdk/aws-autoscaling » CfnScheduledActionProps

Properties for defining a CfnScheduledAction.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as autoscaling from '@aws-cdk/aws-autoscaling';
const cfnScheduledActionProps: autoscaling.CfnScheduledActionProps = {
  autoScalingGroupName: 'autoScalingGroupName',

  // the properties below are optional
  desiredCapacity: 123,
  endTime: 'endTime',
  maxSize: 123,
  minSize: 123,
  recurrence: 'recurrence',
  startTime: 'startTime',
  timeZone: 'timeZone',
};

Properties

NameTypeDescription
autoScalingGroupNamestringThe name of the Auto Scaling group.
desiredCapacity?numberThe desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
endTime?stringThe date and time for the recurring schedule to end, in UTC.
maxSize?numberThe maximum size of the Auto Scaling group.
minSize?numberThe minimum size of the Auto Scaling group.
recurrence?stringThe recurring schedule for this action.
startTime?stringThe 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?stringSpecifies the time zone for a cron expression.

autoScalingGroupName

Type: string

The name of the Auto Scaling group.

desiredCapacity?

Type: number (optional)

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

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 .

endTime?

Type: string (optional)

The date and time for the recurring schedule to end, in UTC.

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

maxSize?

Type: number (optional)

The maximum size of the Auto Scaling group.

minSize?

Type: number (optional)

The minimum size of the Auto Scaling group.

recurrence?

Type: string (optional)

The recurring schedule for this action.

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.

startTime?

Type: string (optional)

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

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.

timeZone?

Type: string (optional)

Specifies the time zone for a cron expression.

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 .

← PreviousNext →