AWS::ApplicationSignals::ServiceLevelObjective RequestBasedSliMetric - 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 RequestBasedSliMetric

This structure contains the information about the metric that is used for a request-based SLO.

Syntax

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

Properties

DependencyConfig

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

Required: No

Type: DependencyConfig

Update requires: No interruption

KeyAttributes

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

  • Type designates the type of object that this SLO is related to.

  • 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.

  • AwsAccountId allows you to create an SLO for an object that exists in another account.

Required: No

Type: String

Pattern: ^.+$

Update requires: No interruption

MetricType

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

Required: No

Type: String

Allowed values: LATENCY | AVAILABILITY

Update requires: No interruption

MonitoredRequestCountMetric

Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Required: No

Type: MonitoredRequestCountMetric

Update requires: No interruption

OperationName

If the SLO monitors a specific operation of the service, this field displays that operation name.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

TotalRequestCountMetric

This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.

Required: No

Type: Array of MetricDataQuery

Update requires: No interruption