View a markdown version of this page

AWS::CloudWatch::LogAlarm ScheduleConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CloudWatch::LogAlarm ScheduleConfiguration

The schedule and time-range offset configuration for the underlying scheduled query.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "EndTimeOffset" : Integer,
  "ScheduleExpression" : String,
  "StartTimeOffset" : Integer
}

YAML

  EndTimeOffset: Integer
  ScheduleExpression: String
  StartTimeOffset: Integer

Properties

EndTimeOffset

The offset, in seconds, before the scheduled execution time at which the query time range ends. Must be non-negative and less than StartTimeOffset. The default is 0.

Required: No

Type: Integer

Update requires: No interruption

ScheduleExpression

The schedule expression that defines how often the underlying CloudWatch Logs scheduled query runs. Specify a rate() expression, for example rate(5 minutes).

Required: Yes

Type: String

Update requires: No interruption

StartTimeOffset

The offset, in seconds, before the scheduled execution time at which the query time range begins. For example, an offset of 360 (6 minutes) on a query running at 12:05:00 starts the query time range at 11:59:00.

Required: No

Type: Integer

Update requires: No interruption