AWS::Connect::Metric

Connect Metric

Resource Type definition for AWS::Connect::Metric, a custom metric configured for an Amazon Connect instance

Properties

8 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`InstanceArn`	`string`	RequiredCreate-only
`MetricCalculation`	`object`	Required
`Name`	`string`	Required
`Status`	`string`	RequiredCreate-only
`Unit`	`string`	Required
`Description`	`string`
`PositiveTrendIndicator`	`string`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Category`	`string`	The category of the custom metric
`CreatedTime`	`number`	The timestamp where the metric was created
`CreatedUser`	`CreatedByInfo`	-
`CreationMethod`	`string`	Whether the metric was built with the guided Service Level (SL) experience, or with the free-form metric builder
`EffectiveTime`	`number`	Earliest time that can be queried for this metric
`Filters`	`Array<AvailableFilter>`	List of filter types that may be used with this metric
`Groupings`	`Array<string>`	List of groupings that may be used with this metric
`LastModifiedRegion`	`string`	The AWS region where the metric was last modified
`LastModifiedTime`	`number`	The timestamp where the metric was last modified
`LastModifiedUser`	`CreatedByInfo`	-
`MetricArn`	`string`	The Amazon Resource Name (ARN) for the custom metric.
`PrimaryEventSource`	`string`	Main provider of the document/row-level data for the metric; should match Data Lake table names
`PrimaryEventSourceEffectiveTimestampType`	`string`	Identifies the timestamp used to place the metrics on a time-series; should match public attribute name
`RefreshRate`	`integer`	Recommended time to wait between each refresh of data for the metric
`SupportedStats`	`Array<string>`	List of stat aggregations available for the metric
`SupportsCustomCalculation`	`boolean`	The metric may be used to compose other (custom) metrics
`SupportsPreaggregateCalculation`	`boolean`	The metric may be used to compose other (custom) metrics, meaning it can be used inside of aggregate stat functions
`Type`	`string`	Whether the metric is provided out-of-the-box or created by each customer

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Connect::Metric

Resources:
  MyResource:
    Type: AWS::Connect::Metric
    Properties:
      InstanceArn: "arn:aws:service:region:account:resource"
      Name: "my-name"
      MetricCalculation: {}
      Unit: "INTEGER"
      Status: "SAVED"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

connect:CreateMetricconnect:TagResource

read

connect:DescribeMetric

update

connect:UpdateMetricMetadataconnect:UpdateMetricContentconnect:TagResourceconnect:UntagResource

delete

connect:DeleteMetricconnect:UntagResource

list

connect:ListMetrics

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceConnect

Properties26

Required5

TaggingSupported

Primary IDMetricArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

InstanceArnStatus

Related Resources

External Links

AWS Documentation