Skip to content
v2.273.0

CfnAnomalyMonitorProps Struct ​

Properties for defining a CfnAnomalyMonitor.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ce as ce } from 'aws-cdk-lib';
const cfnAnomalyMonitorProps: ce.CfnAnomalyMonitorProps = {
  monitorName: 'monitorName',
  monitorType: 'monitorType',

  // the properties below are optional
  monitorDimension: 'monitorDimension',
  monitorSpecification: 'monitorSpecification',
  resourceTags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

monitorDimensionstringmonitor_dimensionstrmonitorDimensionStringMonitorDimensionstringMonitorDimension*string#
For customer managed monitors, do not specify this field.
notes

For AWS managed monitors, this field controls which cost dimension is automatically analyzed by the monitor. For TAG and COST_CATEGORY dimensions, you must also specify MonitorSpecification to configure the specific tag or cost category key to analyze.

monitorNamestringmonitor_namestrmonitorNameStringMonitorNamestringMonitorName*stringrequired#
The name of the monitor.
monitorSpecificationstringmonitor_specificationstrmonitorSpecificationStringMonitorSpecificationstringMonitorSpecification*string#
The array of `MonitorSpecification` in JSON array format.
notes

For instance, you can use MonitorSpecification to specify a tag, Cost Category, or linked account for your custom anomaly monitor. For further information, see the Examples section of this page.

monitorTypestringmonitor_typestrmonitorTypeStringMonitorTypestringMonitorType*stringrequired#
The type of the monitor.
notes

Set this to DIMENSIONAL for an AWS managed monitor. AWS managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an AWS managed monitor.

Set this to CUSTOM for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate.

For more information about monitor types, see Monitor types in the Billing and Cost Management User Guide .

resourceTagsCfnAnomalyMonitor.ResourceTagProperty[]resource_tagstyping.List[ResourceTagProperty]resourceTagsList<ResourceTagProperty>ResourceTagsResourceTagProperty[]ResourceTags*[]ResourceTagProperty#
Tags to assign to monitor.

Used as props by ​