AWS::ApplicationSignals::ServiceLevelObjective - AWS CloudFormation

AWS::ApplicationSignals::ServiceLevelObjective

Creates or updates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.

Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.

When you create an SLO, you set an attainment goal for it. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

After you have created an SLO, you can retrieve error budget reports for it. An error budget is the number of periods or amount of time that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. for example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.

When you call this operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:

  • xray:GetServiceGraph

  • logs:StartQuery

  • logs:GetQueryResults

  • cloudwatch:GetMetricData

  • cloudwatch:ListMetrics

  • tag:GetResources

  • autoscaling:DescribeAutoScalingGroups

You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.

For more information about SLOs, see Service level objectives (SLOs).

Syntax

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

JSON

{ "Type" : "AWS::ApplicationSignals::ServiceLevelObjective", "Properties" : { "Description" : String, "Goal" : Goal, "Name" : String, "Sli" : Sli, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::ApplicationSignals::ServiceLevelObjective Properties: Description: String Goal: Goal Name: String Sli: Sli Tags: - Tag

Properties

Description

An optional description for this SLO.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Goal

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

Required: No

Type: Goal

Update requires: No interruption

Name

A name for this SLO.

Required: Yes

Type: String

Pattern: ^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$

Update requires: Replacement

Sli

A structure containing information about the performance metric that this SLO monitors.

Required: Yes

Type: Sli

Update requires: No interruption

Tags

A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SLO. For example, arn:aws:cloudwatch:us-west-1:123456789012:slo:my-slo-name

Fn::GetAtt

Arn

The ARN of this SLO.

CreatedTime

The date and time that this SLO was created.

LastUpdatedTime

The time that this SLO was most recently updated.