View a markdown version of this page

AWS::Connect::Metric - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Connect::Metric

Creates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing AWS-managed metrics, optionally with filters applied.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::Metric",
  "Properties" : {
      "Description" : String,
      "InstanceArn" : String,
      "MetricCalculation" : MetricCalculation,
      "Name" : String,
      "PositiveTrendIndicator" : String,
      "Status" : String,
      "Tags" : [ Tag, ... ],
      "Unit" : String
    }
}

YAML

Type: AWS::Connect::Metric
Properties:
  Description: String
  InstanceArn: String
  MetricCalculation: 
    MetricCalculation
  Name: String
  PositiveTrendIndicator: String
  Status: String
  Tags: 
    - Tag
  Unit: String

Properties

Description

The description of the metric.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Update requires: Replacement

MetricCalculation

The calculation definition for the metric.

Required: No

Type: MetricCalculation

Update requires: No interruption

Name

The name of the metric.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

PositiveTrendIndicator

How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

Required: No

Type: String

Allowed values: POSITIVE | NEGATIVE | NEUTRAL

Update requires: No interruption

Status

The publish status of the metric. Valid values: PUBLISHED | SAVED.

Required: No

Type: String

Allowed values: SAVED | PUBLISHED

Update requires: Replacement

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Unit

The display unit for the metric's data.

Required: No

Type: String

Allowed values: INTEGER | DOUBLE | PERCENT | SECONDS

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Category

The category of the metric.

CreatedTime

The timestamp of when the metric was created.

CreationMethod

The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).

EffectiveTime

The earliest time that can be queried for this metric.

Filters

The filters applied to the metric.

Groupings

The groupings available for this metric.

LastModifiedRegion

The region where the metric was last modified.

LastModifiedTime

The timestamp of when the metric was last modified.

MetricArn

Property description not available.

PrimaryEventSource

The primary event source for the metric data.

PrimaryEventSourceEffectiveTimestampType

The timestamp type that determines where the metric appears on a time series.

RefreshRate

The minimum interval, in seconds, between data refreshes for this metric.

SupportedStats

The stat aggregations available for this metric.

SupportsCustomCalculation

Specifies whether the metric can be used as a component of custom metrics.

SupportsPreaggregateCalculation

Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.

Type

The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.