GradientEdge CDK Utils
    Preparing search index...

    Interface MetricProps

    interface MetricProps {
        account?: string;
        apiName?: string;
        cacheClusterId?: string;
        clusterName?: string;
        color?: string;
        dbClusterIdentifier?: string;
        dimensionsMap?: DimensionsMap;
        distributionId?: string;
        eventBusName?: string;
        functionName?: string;
        id?: string;
        label?: string;
        loadBalancer?: string;
        metricName: string;
        namespace: string;
        period?: Duration;
        periodInSecs?: number;
        region?: string;
        ruleName?: string;
        service?: string;
        serviceName?: string;
        stackAccount?: string;
        stackRegion?: string;
        stageSuffix: boolean;
        stateMachineArn?: string;
        statistic?: string;
        unit?: Unit;
        visible?: boolean;
    }

    Hierarchy

    • MetricProps
      • MetricProps
    Index

    Properties

    account? apiName? cacheClusterId? clusterName? color? dbClusterIdentifier? dimensionsMap? distributionId? eventBusName? functionName? id? label? loadBalancer? metricName namespace period? periodInSecs? region? ruleName? service? serviceName? stackAccount? stackRegion? stageSuffix stateMachineArn? statistic? unit? visible?

    Properties

    account?: string

    Account which this metric comes from.

    - Deployment account.
    apiName?: string

    The API Gateway API name dimension

    cacheClusterId?: string

    The ElastiCache cluster ID dimension

    clusterName?: string

    The ECS cluster name dimension

    color?: string

    The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here.

    - Automatic color
    dbClusterIdentifier?: string

    The RDS DB cluster identifier dimension

    dimensionsMap?: DimensionsMap

    Dimensions of the metric

    - No dimensions.
    distributionId?: string

    The CloudFront distribution ID dimension

    eventBusName?: string

    The EventBridge event bus name dimension

    functionName?: string

    The Lambda function name dimension

    id?: string

    Unique identifier for this metric when used in dashboard widgets.

    The id can be used as a variable to represent this metric in math expressions. Valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

    - No ID
    label?: string

    Label for this metric when added to a Graph in a Dashboard

    You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:

    [max: ${MAX}] MyMetric

    As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend.

    - No label
    loadBalancer?: string

    The ELB load balancer reference dimension

    metricName: string

    Name of the metric.

    namespace: string

    Namespace of the metric.

    period?: Duration

    The period over which the specified statistic is applied.

    Duration.minutes(5)
    periodInSecs?: number

    The metric period in seconds (defaults to 5 minutes)

    region?: string

    Region which this metric comes from.

    - Deployment region.
    ruleName?: string

    The EventBridge rule name dimension

    service?: string

    A custom service identifier dimension

    serviceName?: string

    The ECS service name dimension

    stackAccount?: string

    Account of the stack this metric is attached to.

    - Deployment account.
    stackRegion?: string

    Region of the stack this metric is attached to.

    - Deployment region.
    stageSuffix: boolean

    Whether to append the deployment stage to the metric name and namespace

    stateMachineArn?: string

    The Step Functions state machine ARN dimension

    statistic?: string

    What function to use for aggregating.

    Use the aws_cloudwatch.Stats helper class to construct valid input strings.

    Can be one of the following:

    • "Minimum" | "min"
    • "Maximum" | "max"
    • "Average" | "avg"
    • "Sum" | "sum"
    • "SampleCount | "n"
    • "pNN.NN"
    • "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
    • "iqm"
    • "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
    • "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
    • "tsNN.NN" | "ts(NN.NN%:NN.NN%)"
    Average
    unit?: Unit

    Unit used to filter the metric stream

    Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

    The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.

    CloudWatch does not honor this property for graphs.

    - All metric datums in the given metric stream
    visible?: boolean

    Whether this metric should be visible in dashboard graphs.

    Setting this to false is useful when you want to hide raw metrics that are used in math expressions, and show only the expression results.

    true

    Settings

    Member Visibility

    On This Page

    Properties