Interface CfnServiceLevelObjective.RequestBasedSliMetricProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServiceLevelObjective.RequestBasedSliMetricProperty.Jsii$Proxy
- Enclosing class:
CfnServiceLevelObjective
@Stability(Stable)
public static interface CfnServiceLevelObjective.RequestBasedSliMetricProperty
extends software.amazon.jsii.JsiiSerializable
This structure contains the information about the metric that is used for a request-based SLO.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.applicationsignals.*; RequestBasedSliMetricProperty requestBasedSliMetricProperty = RequestBasedSliMetricProperty.builder() .keyAttributes(Map.of( "keyAttributesKey", "keyAttributes")) .metricType("metricType") .monitoredRequestCountMetric(MonitoredRequestCountMetricProperty.builder() .badCountMetric(List.of(MetricDataQueryProperty.builder() .id("id") // the properties below are optional .accountId("accountId") .expression("expression") .metricStat(MetricStatProperty.builder() .metric(MetricProperty.builder() .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .metricName("metricName") .namespace("namespace") .build()) .period(123) .stat("stat") // the properties below are optional .unit("unit") .build()) .returnData(false) .build())) .goodCountMetric(List.of(MetricDataQueryProperty.builder() .id("id") // the properties below are optional .accountId("accountId") .expression("expression") .metricStat(MetricStatProperty.builder() .metric(MetricProperty.builder() .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .metricName("metricName") .namespace("namespace") .build()) .period(123) .stat("stat") // the properties below are optional .unit("unit") .build()) .returnData(false) .build())) .build()) .operationName("operationName") .totalRequestCountMetric(List.of(MetricDataQueryProperty.builder() .id("id") // the properties below are optional .accountId("accountId") .expression("expression") .metricStat(MetricStatProperty.builder() .metric(MetricProperty.builder() .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .metricName("metricName") .namespace("namespace") .build()) .period(123) .stat("stat") // the properties below are optional .unit("unit") .build()) .returnData(false) .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnServiceLevelObjective.RequestBasedSliMetricProperty
static final class
An implementation forCfnServiceLevelObjective.RequestBasedSliMetricProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
This is a string-to-string map that contains information about the type of object that this SLO is related to.default String
If the SLO monitors either theLATENCY
orAVAILABILITY
metric that Application Signals collects, this field displays which of those metrics is used.default Object
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.default String
If the SLO monitors a specific operation of the service, this field displays that operation name.default Object
This structure defines the metric that is used as the "total requests" number for a request-based SLO.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getKeyAttributes
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 theType
field isResource
orAWS::Resource
.Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
.Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
.Environment
specifies the location where this object is hosted, or what it belongs to.
- See Also:
-
getMetricType
If the SLO monitors either theLATENCY
orAVAILABILITY
metric that Application Signals collects, this field displays which of those metrics is used.- See Also:
-
getMonitoredRequestCountMetric
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 forMonitoredRequestCountMetric
to determine the percentage of successful requests that this SLO tracks.- See Also:
-
getOperationName
If the SLO monitors a specific operation of the service, this field displays that operation name.- See Also:
-
getTotalRequestCountMetric
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
.- See Also:
-
builder
-