Amazon CloudWatch Application Signals now supports creating Service Level Objectives with burn rates. Users can now create or update SLOs with burn rate configurations to meet their specific business requirements.

Author: aws-sdk-dotnet-automation

generator/ServiceModels/application-signals/application-signals-2024-04-15.api.json

@@ -311,6 +311,25 @@
       "type":"integer",
       "box":true
     },
+    "BurnRateConfiguration":{
+      "type":"structure",
+      "required":["LookBackWindowMinutes"],
+      "members":{
+        "LookBackWindowMinutes":{"shape":"BurnRateLookBackWindowMinutes"}
+      }
+    },
+    "BurnRateConfigurations":{
+      "type":"list",
+      "member":{"shape":"BurnRateConfiguration"},
+      "max":10,
+      "min":0
+    },
+    "BurnRateLookBackWindowMinutes":{
+      "type":"integer",
+      "box":true,
+      "max":10080,
+      "min":1
+    },
     "CalendarInterval":{
       "type":"structure",
       "required":[
@@ -350,7 +369,8 @@
         "SliConfig":{"shape":"ServiceLevelIndicatorConfig"},
         "RequestBasedSliConfig":{"shape":"RequestBasedServiceLevelIndicatorConfig"},
         "Goal":{"shape":"Goal"},
-        "Tags":{"shape":"TagList"}
+        "Tags":{"shape":"TagList"},
+        "BurnRateConfigurations":{"shape":"BurnRateConfigurations"}
       }
     },
     "CreateServiceLevelObjectiveOutput":{
@@ -1091,7 +1111,8 @@
         "Sli":{"shape":"ServiceLevelIndicator"},
         "RequestBasedSli":{"shape":"RequestBasedServiceLevelIndicator"},
         "EvaluationType":{"shape":"EvaluationType"},
-        "Goal":{"shape":"Goal"}
+        "Goal":{"shape":"Goal"},
+        "BurnRateConfigurations":{"shape":"BurnRateConfigurations"}
       }
     },
     "ServiceLevelObjectiveArn":{
@@ -1384,7 +1405,8 @@
         "Description":{"shape":"ServiceLevelObjectiveDescription"},
         "SliConfig":{"shape":"ServiceLevelIndicatorConfig"},
         "RequestBasedSliConfig":{"shape":"RequestBasedServiceLevelIndicatorConfig"},
-        "Goal":{"shape":"Goal"}
+        "Goal":{"shape":"Goal"},
+        "BurnRateConfigurations":{"shape":"BurnRateConfigurations"}
       }
     },
     "UpdateServiceLevelObjectiveOutput":{

generator/ServiceModels/application-signals/application-signals-2024-04-15.docs.json

@@ -105,6 +105,26 @@
         "ServiceLevelObjectiveBudgetReport$BudgetSecondsRemaining": "<p>The budget amount remaining before the SLO status becomes <code>BREACHING</code>, at the time specified in the <code>Timestemp</code> parameter of the request. If this value is negative, then the SLO is already in <code>BREACHING</code> status.</p> <p> This field is included only if the SLO is a period-based SLO.</p>"
       }
     },
+    "BurnRateConfiguration": {
+      "base": "<p>This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.</p> <p>For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:</p> <p> <i>burn rate = error rate over the look-back window / (1 - attainment goal percentage)</i> </p> <p>For more information about burn rates, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn\">Calculate burn rates</a>.</p>",
+      "refs": {
+        "BurnRateConfigurations$member": null
+      }
+    },
+    "BurnRateConfigurations": {
+      "base": null,
+      "refs": {
+        "CreateServiceLevelObjectiveInput$BurnRateConfigurations": "<p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>",
+        "ServiceLevelObjective$BurnRateConfigurations": "<p>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.</p>",
+        "UpdateServiceLevelObjectiveInput$BurnRateConfigurations": "<p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>"
+      }
+    },
+    "BurnRateLookBackWindowMinutes": {
+      "base": null,
+      "refs": {
+        "BurnRateConfiguration$LookBackWindowMinutes": "<p>The number of minutes to use as the look-back window.</p>"
+      }
+    },
     "CalendarInterval": {
       "base": "<p>If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.</p>",
       "refs": {

generator/ServiceModels/application-signals/application-signals-2024-04-15.normal.json

@@ -342,6 +342,29 @@
       "type":"integer",
       "box":true
     },
+    "BurnRateConfiguration":{
+      "type":"structure",
+      "required":["LookBackWindowMinutes"],
+      "members":{
+        "LookBackWindowMinutes":{
+          "shape":"BurnRateLookBackWindowMinutes",
+          "documentation":"<p>The number of minutes to use as the look-back window.</p>"
+        }
+      },
+      "documentation":"<p>This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.</p> <p>For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:</p> <p> <i>burn rate = error rate over the look-back window / (1 - attainment goal percentage)</i> </p> <p>For more information about burn rates, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn\">Calculate burn rates</a>.</p>"
+    },
+    "BurnRateConfigurations":{
+      "type":"list",
+      "member":{"shape":"BurnRateConfiguration"},
+      "max":10,
+      "min":0
+    },
+    "BurnRateLookBackWindowMinutes":{
+      "type":"integer",
+      "box":true,
+      "max":10080,
+      "min":1
+    },
     "CalendarInterval":{
       "type":"structure",
       "required":[
@@ -410,6 +433,10 @@
         "Tags":{
           "shape":"TagList",
           "documentation":"<p>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 <code>cloudwatch:TagResource</code> permission.</p> <p>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.</p>"
+        },
+        "BurnRateConfigurations":{
+          "shape":"BurnRateConfigurations",
+          "documentation":"<p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>"
         }
       }
     },
@@ -1535,7 +1562,11 @@
           "shape":"EvaluationType",
           "documentation":"<p>Displays whether this is a period-based SLO or a request-based SLO.</p>"
         },
-        "Goal":{"shape":"Goal"}
+        "Goal":{"shape":"Goal"},
+        "BurnRateConfigurations":{
+          "shape":"BurnRateConfigurations",
+          "documentation":"<p>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.</p>"
+        }
       },
       "documentation":"<p>A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.</p>"
     },
@@ -1940,6 +1971,10 @@
         "Goal":{
           "shape":"Goal",
           "documentation":"<p>A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.</p>"
+        },
+        "BurnRateConfigurations":{
+          "shape":"BurnRateConfigurations",
+          "documentation":"<p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>"
         }
       }
     },

sdk/code-analysis/ServiceAnalysis/ApplicationSignals/Generated/PropertyValueRules.xml

@@ -71,6 +71,11 @@
     <property>Amazon.ApplicationSignals.Model.UpdateServiceLevelObjectiveRequest.Id</property>
     <pattern>[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$|^arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]</pattern>
   </property-value-rule>
+  <property-value-rule>
+    <property>Amazon.ApplicationSignals.Model.BurnRateConfiguration.LookBackWindowMinutes</property>
+    <min>1</min>
+    <max>10080</max>
+  </property-value-rule>
   <property-value-rule>
     <property>Amazon.ApplicationSignals.Model.CalendarInterval.Duration</property>
     <min>1</min>

sdk/src/Services/ApplicationSignals/Generated/Model/BurnRateConfiguration.cs

@@ -0,0 +1,78 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the application-signals-2024-04-15.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.ApplicationSignals.Model
+{
+    /// <summary>
+    /// This object 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. A burn rate of exactly
+    /// 1 indicates that the SLO goal will be met exactly.
+    /// 
+    ///  
+    /// <para>
+    /// For example, if you specify 60 as the number of minutes in the look-back window, the
+    /// burn rate is calculated as the following:
+    /// </para>
+    ///  
+    /// <para>
+    ///  <i>burn rate = error rate over the look-back window / (1 - attainment goal percentage)</i>
+    /// 
+    /// </para>
+    ///  
+    /// <para>
+    /// For more information about burn rates, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn">Calculate
+    /// burn rates</a>.
+    /// </para>
+    /// </summary>
+    public partial class BurnRateConfiguration
+    {
+        private int? _lookBackWindowMinutes;
+
+        /// <summary>
+        /// Gets and sets the property LookBackWindowMinutes. 
+        /// <para>
+        /// The number of minutes to use as the look-back window.
+        /// </para>
+        /// </summary>
+        [AWSProperty(Required=true, Min=1, Max=10080)]
+        public int LookBackWindowMinutes
+        {
+            get { return this._lookBackWindowMinutes.GetValueOrDefault(); }
+            set { this._lookBackWindowMinutes = value; }
+        }
+
+        // Check to see if LookBackWindowMinutes property is set
+        internal bool IsSetLookBackWindowMinutes()
+        {
+            return this._lookBackWindowMinutes.HasValue; 
+        }
+
+    }
+}

sdk/src/Services/ApplicationSignals/Generated/Model/CreateServiceLevelObjectiveRequest.cs

@@ -147,13 +147,35 @@ namespace Amazon.ApplicationSignals.Model
     /// </summary>
     public partial class CreateServiceLevelObjectiveRequest : AmazonApplicationSignalsRequest
     {
+        private List<BurnRateConfiguration> _burnRateConfigurations = AWSConfigs.InitializeCollections ? new List<BurnRateConfiguration>() : null;
         private string _description;
         private Goal _goal;
         private string _name;
         private RequestBasedServiceLevelIndicatorConfig _requestBasedSliConfig;
         private ServiceLevelIndicatorConfig _sliConfig;
         private List<Tag> _tags = AWSConfigs.InitializeCollections ? new List<Tag>() : null;
 
+        /// <summary>
+        /// Gets and sets the property BurnRateConfigurations. 
+        /// <para>
+        /// Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric
+        /// that indicates how fast the service is consuming the error budget, relative to the
+        /// attainment goal of the SLO.
+        /// </para>
+        /// </summary>
+        [AWSProperty(Min=0, Max=10)]
+        public List<BurnRateConfiguration> BurnRateConfigurations
+        {
+            get { return this._burnRateConfigurations; }
+            set { this._burnRateConfigurations = value; }
+        }
+
+        // Check to see if BurnRateConfigurations property is set
+        internal bool IsSetBurnRateConfigurations()
+        {
+            return this._burnRateConfigurations != null && (this._burnRateConfigurations.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
         /// <summary>
         /// Gets and sets the property Description. 
         /// <para>

sdk/src/Services/ApplicationSignals/Generated/Model/Internal/MarshallTransformations/BurnRateConfigurationMarshaller.cs

@@ -0,0 +1,65 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the application-signals-2024-04-15.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
+using System.Text;
+using System.Xml.Serialization;
+
+using Amazon.ApplicationSignals.Model;
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+using Amazon.Runtime.Internal.Transform;
+using Amazon.Runtime.Internal.Util;
+using ThirdParty.Json.LitJson;
+
+#pragma warning disable CS0612,CS0618
+namespace Amazon.ApplicationSignals.Model.Internal.MarshallTransformations
+{
+    /// <summary>
+    /// BurnRateConfiguration Marshaller
+    /// </summary>
+    public class BurnRateConfigurationMarshaller : IRequestMarshaller<BurnRateConfiguration, JsonMarshallerContext> 
+    {
+        /// <summary>
+        /// Unmarshaller the response from the service to the response class.
+        /// </summary>  
+        /// <param name="requestObject"></param>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public void Marshall(BurnRateConfiguration requestObject, JsonMarshallerContext context)
+        {
+            if(requestObject == null)
+                return;
+            if(requestObject.IsSetLookBackWindowMinutes())
+            {
+                context.Writer.WritePropertyName("LookBackWindowMinutes");
+                context.Writer.Write(requestObject.LookBackWindowMinutes);
+            }
+
+        }
+
+        /// <summary>
+        /// Singleton Marshaller.
+        /// </summary>
+        public readonly static BurnRateConfigurationMarshaller Instance = new BurnRateConfigurationMarshaller();
+
+    }
+}