applicationsignals/aws.sdk.kotlin.services.applicationsignals.model/ServiceLevelObjectiveBudgetReport/Builder

Builder

Properties

The ARN of the SLO that this report is for.

A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

budgetRequestsRemaining

var budgetRequestsRemaining: Int?

This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.

budgetSecondsRemaining

var budgetSecondsRemaining: Int?

The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.

budgetStatus

var budgetStatus: ServiceLevelObjectiveBudgetStatus?

The status of this SLO, as it relates to the error budget for the entire time interval.

evaluationType

var evaluationType: EvaluationType?

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

goal

var goal: Goal?

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

name

var name: String?

The name of the SLO that this report is for.

requestBasedSli

var requestBasedSli: RequestBasedServiceLevelIndicator?

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

sli

var sli: ServiceLevelIndicator?

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

totalBudgetRequests

var totalBudgetRequests: Int?

This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.

totalBudgetSeconds

var totalBudgetSeconds: Int?

The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.

Functions

goal

fun goal(block: Goal.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.applicationsignals.model.Goal inside the given block

requestBasedSli

fun requestBasedSli(block: RequestBasedServiceLevelIndicator.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.applicationsignals.model.RequestBasedServiceLevelIndicator inside the given block

sli

fun sli(block: ServiceLevelIndicator.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.applicationsignals.model.ServiceLevelIndicator inside the given block