Package software.amazon.awscdk.services.applicationsignals

Interface CfnServiceLevelObjective.RequestBasedSliMetricProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceLevelObjective.RequestBasedSliMetricProperty.Jsii$Proxy

Enclosing class:

CfnServiceLevelObjective

@Stability(Stable)
public static interface CfnServiceLevelObjective.RequestBasedSliMetricProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationsignals.*;
 RequestBasedSliMetricProperty requestBasedSliMetricProperty = RequestBasedSliMetricProperty.builder()
         .compositeSliConfig(CompositeSliConfigProperty.builder()
                 .selectionConfig(SelectionConfigProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .pattern("pattern")
                         .build())
                 // the properties below are optional
                 .compositeSliComponents(List.of(CompositeSliComponentProperty.builder()
                         .operationName("operationName")
                         .build()))
                 .build())
         .dependencyConfig(DependencyConfigProperty.builder()
                 .dependencyKeyAttributes(Map.of(
                         "dependencyKeyAttributesKey", "dependencyKeyAttributes"))
                 .dependencyOperationName("dependencyOperationName")
                 .build())
         .keyAttributes(Map.of(
                 "keyAttributesKey", "keyAttributes"))
         .metricName("metricName")
         .metricSource(MetricSourceProperty.builder()
                 .metricSourceKeyAttributes(Map.of(
                         "metricSourceKeyAttributesKey", "metricSourceKeyAttributes"))
                 // the properties below are optional
                 .metricSourceAttributes(Map.of(
                         "metricSourceAttributesKey", "metricSourceAttributes"))
                 .build())
         .metricType("metricType")
         .monitoredRequestCountMetric(MonitoredRequestCountMetricProperty.builder()
                 .badCountMetric(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .accountId("accountId")
                         .expression("expression")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .dimensions(List.of(DimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         .build())
                                 .period(123)
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .returnData(false)
                         .build()))
                 .goodCountMetric(List.of(MetricDataQueryProperty.builder()
                         .id("id")
                         // the properties below are optional
                         .accountId("accountId")
                         .expression("expression")
                         .metricStat(MetricStatProperty.builder()
                                 .metric(MetricProperty.builder()
                                         .dimensions(List.of(DimensionProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .metricName("metricName")
                                         .namespace("namespace")
                                         .build())
                                 .period(123)
                                 .stat("stat")
                                 // the properties below are optional
                                 .unit("unit")
                                 .build())
                         .returnData(false)
                         .build()))
                 .build())
         .operationName("operationName")
         .totalRequestCountMetric(List.of(MetricDataQueryProperty.builder()
                 .id("id")
                 // the properties below are optional
                 .accountId("accountId")
                 .expression("expression")
                 .metricStat(MetricStatProperty.builder()
                         .metric(MetricProperty.builder()
                                 .dimensions(List.of(DimensionProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .metricName("metricName")
                                 .namespace("namespace")
                                 .build())
                         .period(123)
                         .stat("stat")
                         // the properties below are optional
                         .unit("unit")
                         .build())
                 .returnData(false)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceLevelObjective.RequestBasedSliMetricProperty.Builder	A builder for CfnServiceLevelObjective.RequestBasedSliMetricProperty
static final class	CfnServiceLevelObjective.RequestBasedSliMetricProperty.Jsii$Proxy	An implementation for CfnServiceLevelObjective.RequestBasedSliMetricProperty

Method Summary

Modifier and Type	Method	Description
static CfnServiceLevelObjective.RequestBasedSliMetricProperty.Builder	builder()
default Object	getCompositeSliConfig()	Returns union: either IResolvable or CfnServiceLevelObjective.CompositeSliConfigProperty
default Object	getDependencyConfig()	Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .
default Object	getKeyAttributes()	This is a string-to-string map that contains information about the type of object that this SLO is related to.
default String	getMetricName()	The name of the metric for non-Application Signals services.
default Object	getMetricSource()	Configuration for identifying the source of metrics for non-Application Signals services.
default String	getMetricType()	If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
default Object	getMonitoredRequestCountMetric()	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.
default String	getOperationName()	If the SLO monitors a specific operation of the service, this field displays that operation name.
default Object	getTotalRequestCountMetric()	This structure defines the metric that is used as the "total requests" number for a request-based SLO.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCompositeSliConfig

@Stability(Stable)
@Nullable
default Object getCompositeSliConfig()

Returns union: either IResolvable or CfnServiceLevelObjective.CompositeSliConfigProperty

See Also:

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

getDependencyConfig

@Stability(Stable)
@Nullable
default Object getDependencyConfig()

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

Returns union: either IResolvable or CfnServiceLevelObjective.DependencyConfigProperty

See Also:

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

getKeyAttributes

@Stability(Stable)
@Nullable
default Object getKeyAttributes()

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

It can include the following fields.

• Type designates the type of object that this SLO is related to.
• ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .
• Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .
• Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .
• Environment specifies the location where this object is hosted, or what it belongs to.
• AwsAccountId allows you to create an SLO for an object that exists in another account.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

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

getMetricName

@Stability(Stable)
@Nullable
default String getMetricName()

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

See Also:

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

getMetricSource

@Stability(Stable)
@Nullable
default Object getMetricSource()

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

Returns union: either IResolvable or CfnServiceLevelObjective.MetricSourceProperty

See Also:

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

getMetricType

@Stability(Stable)
@Nullable
default String getMetricType()

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

See Also:

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

getMonitoredRequestCountMetric

@Stability(Stable)
@Nullable
default Object getMonitoredRequestCountMetric()

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.

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.

Returns union: either IResolvable or CfnServiceLevelObjective.MonitoredRequestCountMetricProperty

See Also:

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

getOperationName

@Stability(Stable)
@Nullable
default String getOperationName()

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

See Also:

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

getTotalRequestCountMetric

@Stability(Stable)
@Nullable
default Object getTotalRequestCountMetric()

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

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnServiceLevelObjective.MetricDataQueryProperty>

See Also:

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

builder

@Stability(Stable)
static CfnServiceLevelObjective.RequestBasedSliMetricProperty.Builder builder()

Returns:

a CfnServiceLevelObjective.RequestBasedSliMetricProperty.Builder of CfnServiceLevelObjective.RequestBasedSliMetricProperty