Class CfnServiceLevelObjective.RequestBasedSliMetricProperty

This structure contains the information about the metric that is used for a request-based SLO.

Inheritance

object

CfnServiceLevelObjective.RequestBasedSliMetricProperty

Implements

CfnServiceLevelObjective.IRequestBasedSliMetricProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ApplicationSignals

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServiceLevelObjective.RequestBasedSliMetricProperty : CfnServiceLevelObjective.IRequestBasedSliMetricProperty

Syntax (vb)

Public Class CfnServiceLevelObjective.RequestBasedSliMetricProperty Implements CfnServiceLevelObjective.IRequestBasedSliMetricProperty

Remarks

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

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.ApplicationSignals;

             var requestBasedSliMetricProperty = new RequestBasedSliMetricProperty {
                 CompositeSliConfig = new CompositeSliConfigProperty {
                     SelectionConfig = new SelectionConfigProperty {
                         Type = "type",

                         // the properties below are optional
                         Pattern = "pattern"
                     },

                     // the properties below are optional
                     CompositeSliComponents = new [] { new CompositeSliComponentProperty {
                         OperationName = "operationName"
                     } }
                 },
                 DependencyConfig = new DependencyConfigProperty {
                     DependencyKeyAttributes = new Dictionary<string, string> {
                         { "dependencyKeyAttributesKey", "dependencyKeyAttributes" }
                     },
                     DependencyOperationName = "dependencyOperationName"
                 },
                 KeyAttributes = new Dictionary<string, string> {
                     { "keyAttributesKey", "keyAttributes" }
                 },
                 MetricName = "metricName",
                 MetricSource = new MetricSourceProperty {
                     MetricSourceKeyAttributes = new Dictionary<string, string> {
                         { "metricSourceKeyAttributesKey", "metricSourceKeyAttributes" }
                     },

                     // the properties below are optional
                     MetricSourceAttributes = new Dictionary<string, string> {
                         { "metricSourceAttributesKey", "metricSourceAttributes" }
                     }
                 },
                 MetricType = "metricType",
                 MonitoredRequestCountMetric = new MonitoredRequestCountMetricProperty {
                     BadCountMetric = new [] { new MetricDataQueryProperty {
                         Id = "id",

                         // the properties below are optional
                         AccountId = "accountId",
                         Expression = "expression",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",

                             // the properties below are optional
                             Unit = "unit"
                         },
                         ReturnData = false
                     } },
                     GoodCountMetric = new [] { new MetricDataQueryProperty {
                         Id = "id",

                         // the properties below are optional
                         AccountId = "accountId",
                         Expression = "expression",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",

                             // the properties below are optional
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 OperationName = "operationName",
                 TotalRequestCountMetric = new [] { new MetricDataQueryProperty {
                     Id = "id",

                     // the properties below are optional
                     AccountId = "accountId",
                     Expression = "expression",
                     MetricStat = new MetricStatProperty {
                         Metric = new MetricProperty {
                             Dimensions = new [] { new DimensionProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             MetricName = "metricName",
                             Namespace = "namespace"
                         },
                         Period = 123,
                         Stat = "stat",

                         // the properties below are optional
                         Unit = "unit"
                     },
                     ReturnData = false
                 } }
             };

Synopsis

Constructors

RequestBasedSliMetricProperty()

This structure contains the information about the metric that is used for a request-based SLO.

Properties

CompositeSliConfig	This structure contains the information about the metric that is used for a request-based SLO.
DependencyConfig	Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .
KeyAttributes	This is a string-to-string map that contains information about the type of object that this SLO is related to.
MetricName	The name of the metric for non-Application Signals services.
MetricSource	Configuration for identifying the source of metrics for non-Application Signals services.
MetricType	If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
MonitoredRequestCountMetric	Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO.
OperationName	If the SLO monitors a specific operation of the service, this field displays that operation name.
TotalRequestCountMetric	This structure defines the metric that is used as the "total requests" number for a request-based SLO.

Constructors

RequestBasedSliMetricProperty()

This structure contains the information about the metric that is used for a request-based SLO.

public RequestBasedSliMetricProperty()

Remarks

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

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.ApplicationSignals;

             var requestBasedSliMetricProperty = new RequestBasedSliMetricProperty {
                 CompositeSliConfig = new CompositeSliConfigProperty {
                     SelectionConfig = new SelectionConfigProperty {
                         Type = "type",

                         // the properties below are optional
                         Pattern = "pattern"
                     },

                     // the properties below are optional
                     CompositeSliComponents = new [] { new CompositeSliComponentProperty {
                         OperationName = "operationName"
                     } }
                 },
                 DependencyConfig = new DependencyConfigProperty {
                     DependencyKeyAttributes = new Dictionary<string, string> {
                         { "dependencyKeyAttributesKey", "dependencyKeyAttributes" }
                     },
                     DependencyOperationName = "dependencyOperationName"
                 },
                 KeyAttributes = new Dictionary<string, string> {
                     { "keyAttributesKey", "keyAttributes" }
                 },
                 MetricName = "metricName",
                 MetricSource = new MetricSourceProperty {
                     MetricSourceKeyAttributes = new Dictionary<string, string> {
                         { "metricSourceKeyAttributesKey", "metricSourceKeyAttributes" }
                     },

                     // the properties below are optional
                     MetricSourceAttributes = new Dictionary<string, string> {
                         { "metricSourceAttributesKey", "metricSourceAttributes" }
                     }
                 },
                 MetricType = "metricType",
                 MonitoredRequestCountMetric = new MonitoredRequestCountMetricProperty {
                     BadCountMetric = new [] { new MetricDataQueryProperty {
                         Id = "id",

                         // the properties below are optional
                         AccountId = "accountId",
                         Expression = "expression",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",

                             // the properties below are optional
                             Unit = "unit"
                         },
                         ReturnData = false
                     } },
                     GoodCountMetric = new [] { new MetricDataQueryProperty {
                         Id = "id",

                         // the properties below are optional
                         AccountId = "accountId",
                         Expression = "expression",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",

                             // the properties below are optional
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 OperationName = "operationName",
                 TotalRequestCountMetric = new [] { new MetricDataQueryProperty {
                     Id = "id",

                     // the properties below are optional
                     AccountId = "accountId",
                     Expression = "expression",
                     MetricStat = new MetricStatProperty {
                         Metric = new MetricProperty {
                             Dimensions = new [] { new DimensionProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             MetricName = "metricName",
                             Namespace = "namespace"
                         },
                         Period = 123,
                         Stat = "stat",

                         // the properties below are optional
                         Unit = "unit"
                     },
                     ReturnData = false
                 } }
             };

Properties

CompositeSliConfig

This structure contains the information about the metric that is used for a request-based SLO.

public object? CompositeSliConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-compositesliconfig

Type union: either IResolvable or CfnServiceLevelObjective.ICompositeSliConfigProperty

DependencyConfig

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

public object? DependencyConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-dependencyconfig

Type union: either IResolvable or CfnServiceLevelObjective.IDependencyConfigProperty

KeyAttributes

This is a string-to-string map that contains information about the type of object that this SLO is related to.

public object? KeyAttributes { get; set; }

Property Value

object

Remarks

It can include the following fields.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-keyattributes

Type union: either IResolvable or Dictionary<string, string>

MetricName

The name of the metric for non-Application Signals services.

public string? MetricName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-metricname

MetricSource

Configuration for identifying the source of metrics for non-Application Signals services.

public object? MetricSource { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-metricsource

Type union: either IResolvable or CfnServiceLevelObjective.IMetricSourceProperty

MetricType

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

public string? MetricType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-metrictype

MonitoredRequestCountMetric

Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO.

public object? MonitoredRequestCountMetric { get; set; }

Property Value

object

Remarks

This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-monitoredrequestcountmetric

Type union: either IResolvable or CfnServiceLevelObjective.IMonitoredRequestCountMetricProperty

OperationName

If the SLO monitors a specific operation of the service, this field displays that operation name.

public string? OperationName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-operationname

TotalRequestCountMetric

This structure defines the metric that is used as the "total requests" number for a request-based SLO.

public object? TotalRequestCountMetric { get; set; }

Property Value

object

Remarks

The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-requestbasedslimetric.html#cfn-applicationsignals-servicelevelobjective-requestbasedslimetric-totalrequestcountmetric

Type union: either IResolvable or (either IResolvable or CfnServiceLevelObjective.IMetricDataQueryProperty)[]

Implements

CfnServiceLevelObjective.IRequestBasedSliMetricProperty