Class CfnScalingPlan.CustomizedLoadMetricSpecificationProperty
CustomizedLoadMetricSpecification
is a subproperty of ScalingInstruction that specifies a customized load metric for predictive scaling to use with AWS Auto Scaling ( Auto Scaling Plans ).
Inheritance
Namespace: Amazon.CDK.AWS.AutoScalingPlans
Assembly: Amazon.CDK.AWS.AutoScalingPlans.dll
Syntax (csharp)
public class CustomizedLoadMetricSpecificationProperty : Object, CfnScalingPlan.ICustomizedLoadMetricSpecificationProperty
Syntax (vb)
Public Class CustomizedLoadMetricSpecificationProperty
Inherits Object
Implements CfnScalingPlan.ICustomizedLoadMetricSpecificationProperty
Remarks
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum
and Average
statistics that CloudWatch computes from metric data.
When you choose a load metric, make sure that the required Sum
and Average
statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum
statistic must represent the total load on the resource, and the Average
statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum
statistic represents the total request count processed by the group, then the Average
statistic for the specified metric must represent the average request count processed by each instance of the group.
If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide .
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AutoScalingPlans;
var customizedLoadMetricSpecificationProperty = new CustomizedLoadMetricSpecificationProperty {
MetricName = "metricName",
Namespace = "namespace",
Statistic = "statistic",
// the properties below are optional
Dimensions = new [] { new MetricDimensionProperty {
Name = "name",
Value = "value"
} },
Unit = "unit"
};
Synopsis
Constructors
CustomizedLoadMetricSpecificationProperty() |
Properties
Dimensions | The dimensions of the metric. |
MetricName | The name of the metric. |
Namespace | The namespace of the metric. |
Statistic | The statistic of the metric. |
Unit | The unit of the metric. |
Constructors
CustomizedLoadMetricSpecificationProperty()
public CustomizedLoadMetricSpecificationProperty()
Properties
Dimensions
The dimensions of the metric.
public object Dimensions { get; set; }
Property Value
System.Object
Remarks
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.
MetricName
The name of the metric.
public string MetricName { get; set; }
Property Value
System.String
Remarks
Namespace
The namespace of the metric.
public string Namespace { get; set; }
Property Value
System.String
Remarks
Statistic
The statistic of the metric.
public string Statistic { get; set; }
Property Value
System.String
Remarks
Unit
The unit of the metric.
public string Unit { get; set; }
Property Value
System.String