Interface CfnServiceLevelObjectiveProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServiceLevelObjectiveProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:30.971Z")
@Stability(Stable)
public interface CfnServiceLevelObjectiveProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnServiceLevelObjective.
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.*;
CfnServiceLevelObjectiveProps cfnServiceLevelObjectiveProps = CfnServiceLevelObjectiveProps.builder()
.name("name")
// the properties below are optional
.burnRateConfigurations(List.of(BurnRateConfigurationProperty.builder()
.lookBackWindowMinutes(123)
.build()))
.description("description")
.exclusionWindows(List.of(ExclusionWindowProperty.builder()
.window(WindowProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.build())
// the properties below are optional
.reason("reason")
.recurrenceRule(RecurrenceRuleProperty.builder()
.expression("expression")
.build())
.startTime("startTime")
.build()))
.goal(GoalProperty.builder()
.attainmentGoal(123)
.interval(IntervalProperty.builder()
.calendarInterval(CalendarIntervalProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.startTime(123)
.build())
.rollingInterval(RollingIntervalProperty.builder()
.duration(123)
.durationUnit("durationUnit")
.build())
.build())
.warningThreshold(123)
.build())
.requestBasedSli(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())
.sli(SliProperty.builder()
.comparisonOperator("comparisonOperator")
.metricThreshold(123)
.sliMetric(SliMetricProperty.builder()
.dependencyConfig(DependencyConfigProperty.builder()
.dependencyKeyAttributes(Map.of(
"dependencyKeyAttributesKey", "dependencyKeyAttributes"))
.dependencyOperationName("dependencyOperationName")
.build())
.keyAttributes(Map.of(
"keyAttributesKey", "keyAttributes"))
.metricDataQueries(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()))
.metricType("metricType")
.operationName("operationName")
.periodSeconds(123)
.statistic("statistic")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnServiceLevelObjectivePropsstatic final classAn implementation forCfnServiceLevelObjectiveProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectEach object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO.default StringAn optional description for this SLO.default ObjectThe time window to be excluded from the SLO performance metrics.default ObjectgetGoal()This structure contains the attributes that determine the goal of an SLO.getName()A name for this SLO.default ObjectA structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.default ObjectgetSli()A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.getTags()A list of key-value pairs to associate with the SLO.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
A name for this SLO.- See Also:
-
getBurnRateConfigurations
Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO.The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnServiceLevelObjective.BurnRateConfigurationProperty>- See Also:
-
getDescription
An optional description for this SLO.Default: - "No description"
- See Also:
-
getExclusionWindows
The time window to be excluded from the SLO performance metrics.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnServiceLevelObjective.ExclusionWindowProperty>- See Also:
-
getGoal
This structure contains the attributes that determine the goal of an SLO.This includes the time period for evaluation and the attainment threshold.
Returns union: either
IResolvableorCfnServiceLevelObjective.GoalProperty- See Also:
-
getRequestBasedSli
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.Returns union: either
IResolvableorCfnServiceLevelObjective.RequestBasedSliProperty- See Also:
-
getSli
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.Returns union: either
IResolvableorCfnServiceLevelObjective.SliProperty- See Also:
-
getTags
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.
- See Also:
-
builder
-