AWS::ApplicationSignals::ServiceLevelObjective SliMetric - AWS CloudFormation
SyntaxProperties

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

AWS::ApplicationSignals::ServiceLevelObjective SliMetric

Use this structure to specify the metric to be used for the SLO.

Syntax

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

JSON

{
  "DependencyConfig" : DependencyConfig,
  "KeyAttributes" : String,
  "MetricDataQueries" : [ MetricDataQuery, ... ],
  "MetricType" : String,
  "OperationName" : String,
  "PeriodSeconds" : Integer,
  "Statistic" : String
}

Properties

DependencyConfig

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

Required: No

Type: DependencyConfig

Update requires: No interruption

KeyAttributes

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.

  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

  • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

  • Environment specifies the location where this object is hosted, or what it belongs to.

Required: No

Type: String

Pattern: ^.+$

Update requires: No interruption

MetricDataQueries

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

Required: No

Type: Array of MetricDataQuery

Update requires: No interruption

MetricType

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

Required: No

Type: String

Allowed values: LATENCY | AVAILABILITY

Update requires: No interruption

OperationName

If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

PeriodSeconds

The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

Required: No

Type: Integer

Minimum: 60

Maximum: 900

Update requires: No interruption

Statistic

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

Required: No

Type: String

Minimum: 1

Maximum: 20

Update requires: No interruption