Package software.amazon.awscdk.services.applicationsignals

Class CfnServiceLevelObjective

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.applicationsignals.CfnServiceLevelObjective

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:38.483Z")
@Stability(Stable)
public class CfnServiceLevelObjective
extends CfnResource
implements IInspectable, ITaggableV2

Creates or updates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.

Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.

Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.

The target performance quality that is defined for an SLO is the attainment goal . An attainment goal is the percentage of time or requests that the SLI is expected to meet the threshold over each time interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO . Each type of SLO has a different way of evaluating your application's performance against its attainment goal.

• A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods .

For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.

• A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.

After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.

• For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.

For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.

• For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.

When you call this operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:

• xray:GetServiceGraph
• logs:StartQuery
• logs:GetQueryResults
• cloudwatch:GetMetricData
• cloudwatch:ListMetrics
• tag:GetResources
• autoscaling:DescribeAutoScalingGroups

You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.

You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.

For more information about SLOs, see Service level objectives (SLOs) .

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.*;
 CfnServiceLevelObjective cfnServiceLevelObjective = CfnServiceLevelObjective.Builder.create(this, "MyCfnServiceLevelObjective")
         .name("name")
         // the properties below are optional
         .description("description")
         .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()
                         .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()
                         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnServiceLevelObjective.Builder	A fluent builder for CfnServiceLevelObjective.
static interface	CfnServiceLevelObjective.CalendarIntervalProperty	If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.
static interface	CfnServiceLevelObjective.DimensionProperty	A dimension is a name/value pair that is part of the identity of a metric.
static interface	CfnServiceLevelObjective.GoalProperty	This structure contains the attributes that determine the goal of an SLO.
static interface	CfnServiceLevelObjective.IntervalProperty	The time period used to evaluate the SLO.
static interface	CfnServiceLevelObjective.MetricDataQueryProperty	Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
static interface	CfnServiceLevelObjective.MetricProperty	This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.
static interface	CfnServiceLevelObjective.MetricStatProperty	This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.
static interface	CfnServiceLevelObjective.MonitoredRequestCountMetricProperty	This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO.
static interface	CfnServiceLevelObjective.RequestBasedSliMetricProperty	This structure contains the information about the metric that is used for a request-based SLO.
static interface	CfnServiceLevelObjective.RequestBasedSliProperty	This structure contains information about the performance metric that a request-based SLO monitors.
static interface	CfnServiceLevelObjective.RollingIntervalProperty	If the interval for this SLO is a rolling interval, this structure contains the interval specifications.
static interface	CfnServiceLevelObjective.SliMetricProperty	Use this structure to specify the metric to be used for the SLO.
static interface	CfnServiceLevelObjective.SliProperty	This structure specifies the information about the service and the performance metric that an SLO is to monitor.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnServiceLevelObjective(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServiceLevelObjective(software.amazon.jsii.JsiiObjectRef objRef)
	CfnServiceLevelObjective(software.constructs.Construct scope, String id, CfnServiceLevelObjectiveProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The ARN of this SLO.
Number	getAttrCreatedTime()	The date and time that this SLO was created.
String	getAttrEvaluationType()	Displays whether this is a period-based SLO or a request-based SLO.
Number	getAttrLastUpdatedTime()	The time that this SLO was most recently updated.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	An optional description for this SLO.
Object	getGoal()	This structure contains the attributes that determine the goal of an SLO.
String	getName()	A name for this SLO.
Object	getRequestBasedSli()	A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
Object	getSli()	A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
List<CfnTag>	getTags()	A list of key-value pairs to associate with the SLO.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	An optional description for this SLO.
void	setGoal(IResolvable value)	This structure contains the attributes that determine the goal of an SLO.
void	setGoal(CfnServiceLevelObjective.GoalProperty value)	This structure contains the attributes that determine the goal of an SLO.
void	setName(String value)	A name for this SLO.
void	setRequestBasedSli(IResolvable value)	A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
void	setRequestBasedSli(CfnServiceLevelObjective.RequestBasedSliProperty value)	A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
void	setSli(IResolvable value)	A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
void	setSli(CfnServiceLevelObjective.SliProperty value)	A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
void	setTags(List<CfnTag> value)	A list of key-value pairs to associate with the SLO.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnServiceLevelObjective

protected CfnServiceLevelObjective(software.amazon.jsii.JsiiObjectRef objRef)

CfnServiceLevelObjective

protected CfnServiceLevelObjective(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServiceLevelObjective

@Stability(Stable)
public CfnServiceLevelObjective(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnServiceLevelObjectiveProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of this SLO.

getAttrCreatedTime

@Stability(Stable)
@NotNull
public Number getAttrCreatedTime()

The date and time that this SLO was created.

getAttrEvaluationType

@Stability(Stable)
@NotNull
public String getAttrEvaluationType()

Displays whether this is a period-based SLO or a request-based SLO.

getAttrLastUpdatedTime

@Stability(Stable)
@NotNull
public Number getAttrLastUpdatedTime()

The time that this SLO was most recently updated.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(Stable)
@NotNull
public String getName()

A name for this SLO.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

A name for this SLO.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

An optional description for this SLO.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

An optional description for this SLO.

getGoal

@Stability(Stable)
@Nullable
public Object getGoal()

This structure contains the attributes that determine the goal of an SLO.

setGoal

@Stability(Stable)
public void setGoal(@Nullable
 IResolvable value)

This structure contains the attributes that determine the goal of an SLO.

setGoal

@Stability(Stable)
public void setGoal(@Nullable
 CfnServiceLevelObjective.GoalProperty value)

This structure contains the attributes that determine the goal of an SLO.

getRequestBasedSli

@Stability(Stable)
@Nullable
public Object getRequestBasedSli()

A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.

setRequestBasedSli

@Stability(Stable)
public void setRequestBasedSli(@Nullable
 IResolvable value)

A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.

setRequestBasedSli

@Stability(Stable)
public void setRequestBasedSli(@Nullable
 CfnServiceLevelObjective.RequestBasedSliProperty value)

A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.

getSli

@Stability(Stable)
@Nullable
public Object getSli()

A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.

setSli

@Stability(Stable)
public void setSli(@Nullable
 IResolvable value)

A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.

setSli

@Stability(Stable)
public void setSli(@Nullable
 CfnServiceLevelObjective.SliProperty value)

A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

A list of key-value pairs to associate with the SLO.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

A list of key-value pairs to associate with the SLO.