Package software.amazon.awscdk.services.applicationsignals

Interface CfnServiceLevelObjective.GoalProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceLevelObjective.GoalProperty.Jsii$Proxy

Enclosing class:

CfnServiceLevelObjective

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

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

This includes the time period for evaluation and the attainment threshold.

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.*;
 GoalProperty goalProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServiceLevelObjective.GoalProperty.Builder	builder()
default Number	getAttainmentGoal()	The threshold that determines if the goal is being met.
default Object	getInterval()	The time period used to evaluate the SLO.
default Number	getWarningThreshold()	The percentage of remaining budget over total budget that you want to get warnings for.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttainmentGoal

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

The threshold that determines if the goal is being met.

If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the 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.

If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

If you omit this parameter, 99 is used to represent 99% as the attainment goal.

See Also:

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

getInterval

@Stability(Stable)
@Nullable
default Object getInterval()

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

If you omit this parameter, a rolling interval of 7 days is used.

Returns union: either IResolvable or CfnServiceLevelObjective.IntervalProperty

See Also:

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

getWarningThreshold

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

The percentage of remaining budget over total budget that you want to get warnings for.

If you omit this parameter, the default of 50.0 is used.

See Also:

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

builder

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

Returns:

a CfnServiceLevelObjective.GoalProperty.Builder of CfnServiceLevelObjective.GoalProperty