AWS::MediaLive::CloudWatchAlarmTemplate - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::MediaLive::CloudWatchAlarmTemplate

The AWS::MediaLive::CloudWatchAlarmTemplate resource Property description not available. for MediaLive.

Syntax

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

JSON

{
  "Type" : "AWS::MediaLive::CloudWatchAlarmTemplate",
  "Properties" : {
      "ComparisonOperator" : String,
      "DatapointsToAlarm" : Number,
      "Description" : String,
      "EvaluationPeriods" : Number,
      "GroupIdentifier" : String,
      "MetricName" : String,
      "Name" : String,
      "Period" : Number,
      "Statistic" : String,
      "Tags" : {Key: Value, ...},
      "TargetResourceType" : String,
      "Threshold" : Number,
      "TreatMissingData" : String
    }
}

YAML

Type: AWS::MediaLive::CloudWatchAlarmTemplate
Properties:
  ComparisonOperator: String
  DatapointsToAlarm: Number
  Description: String
  EvaluationPeriods: Number
  GroupIdentifier: String
  MetricName: String
  Name: String
  Period: Number
  Statistic: String
  Tags: 
    Key: Value
  TargetResourceType: String
  Threshold: Number
  TreatMissingData: String

Properties

ComparisonOperator

The comparison operator used to compare the specified statistic and the threshold.

Required: Yes

Type: String

Allowed values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold

Update requires: No interruption

DatapointsToAlarm

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

Required: No

Type: Number

Minimum: 1

Update requires: No interruption

Description

A resource's optional description.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

EvaluationPeriods

The number of periods over which data is compared to the specified threshold.

Required: Yes

Type: Number

Minimum: 1

Update requires: No interruption

GroupIdentifier

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

Required: No

Type: String

Pattern: ^[^\s]+$

Update requires: No interruption

MetricName

The name of the metric associated with the alarm. Must be compatible with targetResourceType.

Required: Yes

Type: String

Minimum: 0

Maximum: 64

Update requires: No interruption

Name

A resource's name. Names must be unique within the scope of a resource type in a specific region.

Required: Yes

Type: String

Pattern: ^[^\s]+$

Minimum: 1

Maximum: 255

Update requires: No interruption

Period

The period, in seconds, over which the specified statistic is applied.

Required: Yes

Type: Number

Minimum: 10

Maximum: 86400

Update requires: No interruption

Statistic

The statistic to apply to the alarm's metric data.

Required: Yes

Type: String

Allowed values: SampleCount | Average | Sum | Minimum | Maximum

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Object of String

Pattern: .+

Update requires: Replacement

TargetResourceType

The resource type this template should dynamically generate CloudWatch metric alarms for.

Required: Yes

Type: String

Allowed values: CLOUDFRONT_DISTRIBUTION | MEDIALIVE_MULTIPLEX | MEDIALIVE_CHANNEL | MEDIALIVE_INPUT_DEVICE | MEDIAPACKAGE_CHANNEL | MEDIAPACKAGE_ORIGIN_ENDPOINT | MEDIACONNECT_FLOW | MEDIATAILOR_PLAYBACK_CONFIGURATION | S3_BUCKET

Update requires: No interruption

Threshold

The threshold value to compare with the specified statistic.

Required: Yes

Type: Number

Update requires: No interruption

TreatMissingData

Specifies how missing data points are treated when evaluating the alarm's condition.

Required: Yes

Type: String

Allowed values: notBreaching | breaching | ignore | missing

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

A cloudwatch alarm template's ARN (Amazon Resource Name)

CreatedAt

The date and time of resource creation.

GroupId

A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>

Id

A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>.

Identifier

Property description not available.

ModifiedAt

The date and time of latest resource modification.