ServiceLevelIndicatorMetricConfig - Application Signals
ContentsSee Also

ServiceLevelIndicatorMetricConfig

Use this structure to specify the information for the metric that a period-based SLO will monitor.

Contents

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.

Type: String to string map

Map Entries: Maximum number of 3 items.

Key Pattern: [a-zA-Z]{1,50}

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [ -~]*[!-~]+[ -~]*

Required: No

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.

Type: Array of MetricDataQuery objects

Required: No

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.

Type: String

Valid Values: LATENCY | AVAILABILITY

Required: No

OperationName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 900.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: [a-zA-Z0-9.]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: