CfnMetricProps

class aws_cdk.aws_connect.CfnMetricProps(*, instance_arn, description=None, metric_calculation=None, name=None, positive_trend_indicator=None, status=None, tags=None, unit=None)

Bases: object

Properties for defining a CfnMetric.

Parameters:

instance_arn (str) – The identifier of the Amazon Connect instance.
description (Optional[str]) – The description of the custom metric.
metric_calculation (Union[IResolvable, MetricCalculationProperty, Dict[str, Any], None]) – The calculation configuration for the metric.
name (Optional[str]) – The name of the custom metric.
positive_trend_indicator (Optional[str]) – Indicates how to classify a positive trend in metric data on the UI.
status (Optional[str]) – The status of the custom metric.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – One or more tags.
unit (Optional[str]) – Display unit for the metric data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-metric.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_connect as connect

cfn_metric_props = connect.CfnMetricProps(
    instance_arn="instanceArn",

    # the properties below are optional
    description="description",
    metric_calculation=connect.CfnMetric.MetricCalculationProperty(
        calculation="calculation",
        calculation_components=[connect.CfnMetric.CalculationComponentProperty(
            alias="alias",

            # the properties below are optional
            metric_filters=[connect.CfnMetric.MetricFilterProperty(
                metric_filter_key="metricFilterKey",

                # the properties below are optional
                boolean_condition=connect.CfnMetric.MetricFilterBooleanConditionProperty(
                    comparison="comparison"
                ),
                negate=False,
                number_condition=connect.CfnMetric.MetricFilterNumberConditionProperty(
                    comparison="comparison",
                    values=[123]
                ),
                string_condition=connect.CfnMetric.MetricFilterStringConditionProperty(
                    comparison="comparison",
                    values=["values"]
                )
            )],
            metric_id="metricId",
            metric_name="metricName"
        )]
    ),
    name="name",
    positive_trend_indicator="positiveTrendIndicator",
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    unit="unit"
)