Interface CfnServiceLevelObjectivePropsMixin.IRequestBasedSliMetricProperty

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

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApplicationSignals.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnServiceLevelObjectivePropsMixin.IRequestBasedSliMetricProperty

Syntax (vb)

Public Interface CfnServiceLevelObjectivePropsMixin.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.Mixins.Preview.AWS.ApplicationSignals.Mixins;

             var requestBasedSliMetricProperty = new RequestBasedSliMetricProperty {
                 DependencyConfig = new DependencyConfigProperty {
                     DependencyKeyAttributes = new Dictionary<string, string> {
                         { "dependencyKeyAttributesKey", "dependencyKeyAttributes" }
                     },
                     DependencyOperationName = "dependencyOperationName"
                 },
                 KeyAttributes = new Dictionary<string, string> {
                     { "keyAttributesKey", "keyAttributes" }
                 },
                 MetricType = "metricType",
                 MonitoredRequestCountMetric = new MonitoredRequestCountMetricProperty {
                     BadCountMetric = new [] { new MetricDataQueryProperty {
                         AccountId = "accountId",
                         Expression = "expression",
                         Id = "id",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } },
                     GoodCountMetric = new [] { new MetricDataQueryProperty {
                         AccountId = "accountId",
                         Expression = "expression",
                         Id = "id",
                         MetricStat = new MetricStatProperty {
                             Metric = new MetricProperty {
                                 Dimensions = new [] { new DimensionProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 MetricName = "metricName",
                                 Namespace = "namespace"
                             },
                             Period = 123,
                             Stat = "stat",
                             Unit = "unit"
                         },
                         ReturnData = false
                     } }
                 },
                 OperationName = "operationName",
                 TotalRequestCountMetric = new [] { new MetricDataQueryProperty {
                     AccountId = "accountId",
                     Expression = "expression",
                     Id = "id",
                     MetricStat = new MetricStatProperty {
                         Metric = new MetricProperty {
                             Dimensions = new [] { new DimensionProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             MetricName = "metricName",
                             Namespace = "namespace"
                         },
                         Period = 123,
                         Stat = "stat",
                         Unit = "unit"
                     },
                     ReturnData = false
                 } }
             };

Synopsis

Properties

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

Properties

DependencyConfig

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

object? DependencyConfig { get; }

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 CfnServiceLevelObjectivePropsMixin.IDependencyConfigProperty

KeyAttributes

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

object? KeyAttributes { get; }

Property Value

object

Remarks

It can include the following fields.

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

MetricType

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

string? MetricType { get; }

Property Value

string

Remarks

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.

object? MonitoredRequestCountMetric { get; }

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.

Type union: either IResolvable or CfnServiceLevelObjectivePropsMixin.IMonitoredRequestCountMetricProperty

OperationName

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

string? OperationName { get; }

Property Value

string

Remarks

TotalRequestCountMetric

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

object? TotalRequestCountMetric { get; }

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 .

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