We recommend new projects start with resources from the AWS provider.
aws-native.aps.AnomalyDetector
We recommend new projects start with resources from the AWS provider.
AnomalyDetector schema for cloudformation.
Create AnomalyDetector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AnomalyDetector(name: string, args: AnomalyDetectorArgs, opts?: CustomResourceOptions);@overload
def AnomalyDetector(resource_name: str,
args: AnomalyDetectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AnomalyDetector(resource_name: str,
opts: Optional[ResourceOptions] = None,
alias: Optional[str] = None,
configuration: Optional[AnomalyDetectorConfigurationArgs] = None,
workspace: Optional[str] = None,
evaluation_interval_in_seconds: Optional[int] = None,
labels: Optional[Sequence[AnomalyDetectorLabelArgs]] = None,
missing_data_action: Optional[AnomalyDetectorMissingDataActionArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewAnomalyDetector(ctx *Context, name string, args AnomalyDetectorArgs, opts ...ResourceOption) (*AnomalyDetector, error)public AnomalyDetector(string name, AnomalyDetectorArgs args, CustomResourceOptions? opts = null)
public AnomalyDetector(String name, AnomalyDetectorArgs args)
public AnomalyDetector(String name, AnomalyDetectorArgs args, CustomResourceOptions options)
type: aws-native:aps:AnomalyDetector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AnomalyDetectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AnomalyDetectorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AnomalyDetectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AnomalyDetectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AnomalyDetectorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AnomalyDetector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AnomalyDetector resource accepts the following input properties:
- Alias string
- The AnomalyDetector alias.
- Configuration
Pulumi.
Aws Native. Aps. Inputs. Anomaly Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- Workspace string
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- Evaluation
Interval intIn Seconds - The AnomalyDetector period of detection and metric generation.
- Labels
List<Pulumi.
Aws Native. Aps. Inputs. Anomaly Detector Label> - An array of key-value pairs to provide meta-data.
- Missing
Data Pulumi.Action Aws Native. Aps. Inputs. Anomaly Detector Missing Data Action - The action to perform when running the expression returns no data.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Alias string
- The AnomalyDetector alias.
- Configuration
Anomaly
Detector Configuration Args - Determines the anomaly detector's algorithm and its configuration.
- Workspace string
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- Evaluation
Interval intIn Seconds - The AnomalyDetector period of detection and metric generation.
- Labels
[]Anomaly
Detector Label Args - An array of key-value pairs to provide meta-data.
- Missing
Data AnomalyAction Detector Missing Data Action Args - The action to perform when running the expression returns no data.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- alias String
- The AnomalyDetector alias.
- configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- workspace String
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- evaluation
Interval IntegerIn Seconds - The AnomalyDetector period of detection and metric generation.
- labels
List<Anomaly
Detector Label> - An array of key-value pairs to provide meta-data.
- missing
Data AnomalyAction Detector Missing Data Action - The action to perform when running the expression returns no data.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- alias string
- The AnomalyDetector alias.
- configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- workspace string
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- evaluation
Interval numberIn Seconds - The AnomalyDetector period of detection and metric generation.
- labels
Anomaly
Detector Label[] - An array of key-value pairs to provide meta-data.
- missing
Data AnomalyAction Detector Missing Data Action - The action to perform when running the expression returns no data.
- Tag[]
- An array of key-value pairs to apply to this resource.
- alias str
- The AnomalyDetector alias.
- configuration
Anomaly
Detector Configuration Args - Determines the anomaly detector's algorithm and its configuration.
- workspace str
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- evaluation_
interval_ intin_ seconds - The AnomalyDetector period of detection and metric generation.
- labels
Sequence[Anomaly
Detector Label Args] - An array of key-value pairs to provide meta-data.
- missing_
data_ Anomalyaction Detector Missing Data Action Args - The action to perform when running the expression returns no data.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- alias String
- The AnomalyDetector alias.
- configuration Property Map
- Determines the anomaly detector's algorithm and its configuration.
- workspace String
- Required to identify a specific APS Workspace associated with this Anomaly Detector.
- evaluation
Interval NumberIn Seconds - The AnomalyDetector period of detection and metric generation.
- labels List<Property Map>
- An array of key-value pairs to provide meta-data.
- missing
Data Property MapAction - The action to perform when running the expression returns no data.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the AnomalyDetector resource produces the following output properties:
Supporting Types
AnomalyDetectorConfiguration, AnomalyDetectorConfigurationArgs
- Random
Cut Pulumi.Forest Aws Native. Aps. Inputs. Anomaly Detector Random Cut Forest Configuration - The Random Cut Forest algorithm configuration for anomaly detection.
- Random
Cut AnomalyForest Detector Random Cut Forest Configuration - The Random Cut Forest algorithm configuration for anomaly detection.
- random
Cut AnomalyForest Detector Random Cut Forest Configuration - The Random Cut Forest algorithm configuration for anomaly detection.
- random
Cut AnomalyForest Detector Random Cut Forest Configuration - The Random Cut Forest algorithm configuration for anomaly detection.
- random_
cut_ Anomalyforest Detector Random Cut Forest Configuration - The Random Cut Forest algorithm configuration for anomaly detection.
- random
Cut Property MapForest - The Random Cut Forest algorithm configuration for anomaly detection.
AnomalyDetectorIgnoreNearExpected, AnomalyDetectorIgnoreNearExpectedArgs
AnomalyDetectorLabel, AnomalyDetectorLabelArgs
A key-value pair to provide meta-data and multi-dimensional data analysis for filtering and aggregation.- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
AnomalyDetectorMissingDataAction, AnomalyDetectorMissingDataActionArgs
- Mark
As boolAnomaly - Skip bool
- Mark
As boolAnomaly - Skip bool
- mark
As BooleanAnomaly - skip Boolean
- mark
As booleanAnomaly - skip boolean
- mark_
as_ boolanomaly - skip bool
- mark
As BooleanAnomaly - skip Boolean
AnomalyDetectorRandomCutForestConfiguration, AnomalyDetectorRandomCutForestConfigurationArgs
- Query string
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- Ignore
Near Pulumi.Expected From Above Aws Native. Aps. Inputs. Anomaly Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from above during anomaly detection.
- Ignore
Near Pulumi.Expected From Below Aws Native. Aps. Inputs. Anomaly Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from below during anomaly detection.
- Sample
Size int - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- Shingle
Size int - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
- Query string
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- Ignore
Near AnomalyExpected From Above Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from above during anomaly detection.
- Ignore
Near AnomalyExpected From Below Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from below during anomaly detection.
- Sample
Size int - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- Shingle
Size int - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
- query String
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- ignore
Near AnomalyExpected From Above Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from above during anomaly detection.
- ignore
Near AnomalyExpected From Below Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from below during anomaly detection.
- sample
Size Integer - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- shingle
Size Integer - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
- query string
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- ignore
Near AnomalyExpected From Above Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from above during anomaly detection.
- ignore
Near AnomalyExpected From Below Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from below during anomaly detection.
- sample
Size number - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- shingle
Size number - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
- query str
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- ignore_
near_ Anomalyexpected_ from_ above Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from above during anomaly detection.
- ignore_
near_ Anomalyexpected_ from_ below Detector Ignore Near Expected - Configuration for ignoring values that are near expected values from below during anomaly detection.
- sample_
size int - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- shingle_
size int - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
- query String
The Prometheus query used to retrieve the time-series data for anomaly detection.
Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.
Supported PromQL aggregation operators :
avg,count,group,max,min,quantile,stddev,stdvar, andsum.- ignore
Near Property MapExpected From Above - Configuration for ignoring values that are near expected values from above during anomaly detection.
- ignore
Near Property MapExpected From Below - Configuration for ignoring values that are near expected values from below during anomaly detection.
- sample
Size Number - The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
- shingle
Size Number - The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
