Package software.amazon.awscdk.services.applicationsignals

Interface CfnServiceLevelObjective.RequestBasedSliProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceLevelObjective.RequestBasedSliProperty.Jsii$Proxy

Enclosing class:

CfnServiceLevelObjective

@Stability(Stable)
public static interface CfnServiceLevelObjective.RequestBasedSliProperty
extends software.amazon.jsii.JsiiSerializable

This structure contains information about the performance metric that a request-based SLO monitors.

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.*;
 RequestBasedSliProperty requestBasedSliProperty = RequestBasedSliProperty.builder()
         .requestBasedSliMetric(RequestBasedSliMetricProperty.builder()
                 .dependencyConfig(DependencyConfigProperty.builder()
                         .dependencyKeyAttributes(Map.of(
                                 "dependencyKeyAttributesKey", "dependencyKeyAttributes"))
                         .dependencyOperationName("dependencyOperationName")
                         .build())
                 .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())
         // the properties below are optional
         .comparisonOperator("comparisonOperator")
         .metricThreshold(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceLevelObjective.RequestBasedSliProperty.Builder	A builder for CfnServiceLevelObjective.RequestBasedSliProperty
static final class	CfnServiceLevelObjective.RequestBasedSliProperty.Jsii$Proxy	An implementation for CfnServiceLevelObjective.RequestBasedSliProperty

Method Summary

Modifier and Type	Method	Description
static CfnServiceLevelObjective.RequestBasedSliProperty.Builder	builder()
default String	getComparisonOperator()	The arithmetic operation used when comparing the specified metric to the threshold.
default Number	getMetricThreshold()	This value is the threshold that the observed metric values of the SLI metric are compared to.
Object	getRequestBasedSliMetric()	A structure that contains information about the metric that the SLO monitors.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRequestBasedSliMetric

@Stability(Stable)
@NotNull
Object getRequestBasedSliMetric()

A structure that contains information about the metric that the SLO monitors.

Returns union: either IResolvable or CfnServiceLevelObjective.RequestBasedSliMetricProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-requestbasedslimetric

getComparisonOperator

@Stability(Stable)
@Nullable
default String getComparisonOperator()

The arithmetic operation used when comparing the specified metric to the threshold.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-comparisonoperator

getMetricThreshold

@Stability(Stable)
@Nullable
default Number getMetricThreshold()

This value is the threshold that the observed metric values of the SLI metric are compared to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedsli.html#cfn-applicationsignals-servicelevelobjective-requestbasedsli-metricthreshold

builder

@Stability(Stable)
static CfnServiceLevelObjective.RequestBasedSliProperty.Builder builder()

Returns:

a CfnServiceLevelObjective.RequestBasedSliProperty.Builder of CfnServiceLevelObjective.RequestBasedSliProperty