We recommend new projects start with resources from the AWS provider.
aws-native.aps.getAnomalyDetector
We recommend new projects start with resources from the AWS provider.
AnomalyDetector schema for cloudformation.
Using getAnomalyDetector
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAnomalyDetector(args: GetAnomalyDetectorArgs, opts?: InvokeOptions): Promise<GetAnomalyDetectorResult>
function getAnomalyDetectorOutput(args: GetAnomalyDetectorOutputArgs, opts?: InvokeOptions): Output<GetAnomalyDetectorResult>def get_anomaly_detector(arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAnomalyDetectorResult
def get_anomaly_detector_output(arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAnomalyDetectorResult]func LookupAnomalyDetector(ctx *Context, args *LookupAnomalyDetectorArgs, opts ...InvokeOption) (*LookupAnomalyDetectorResult, error)
func LookupAnomalyDetectorOutput(ctx *Context, args *LookupAnomalyDetectorOutputArgs, opts ...InvokeOption) LookupAnomalyDetectorResultOutput> Note: This function is named LookupAnomalyDetector in the Go SDK.
public static class GetAnomalyDetector
{
public static Task<GetAnomalyDetectorResult> InvokeAsync(GetAnomalyDetectorArgs args, InvokeOptions? opts = null)
public static Output<GetAnomalyDetectorResult> Invoke(GetAnomalyDetectorInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAnomalyDetectorResult> getAnomalyDetector(GetAnomalyDetectorArgs args, InvokeOptions options)
public static Output<GetAnomalyDetectorResult> getAnomalyDetector(GetAnomalyDetectorArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:aps:getAnomalyDetector
arguments:
# arguments dictionaryThe following arguments are supported:
- Arn string
- The AnomalyDetector ARN.
- Arn string
- The AnomalyDetector ARN.
- arn String
- The AnomalyDetector ARN.
- arn string
- The AnomalyDetector ARN.
- arn str
- The AnomalyDetector ARN.
- arn String
- The AnomalyDetector ARN.
getAnomalyDetector Result
The following output properties are available:
- Arn string
- The AnomalyDetector ARN.
- Configuration
Pulumi.
Aws Native. Aps. Outputs. Anomaly Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- Evaluation
Interval intIn Seconds - The AnomalyDetector period of detection and metric generation.
- Labels
List<Pulumi.
Aws Native. Aps. Outputs. Anomaly Detector Label> - An array of key-value pairs to provide meta-data.
- Missing
Data Pulumi.Action Aws Native. Aps. Outputs. Anomaly Detector Missing Data Action - The action to perform when running the expression returns no data.
-
List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Arn string
- The AnomalyDetector ARN.
- Configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- Evaluation
Interval intIn 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.
- arn String
- The AnomalyDetector ARN.
- configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- 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.
- arn string
- The AnomalyDetector ARN.
- configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- 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.
- arn str
- The AnomalyDetector ARN.
- configuration
Anomaly
Detector Configuration - Determines the anomaly detector's algorithm and its configuration.
- evaluation_
interval_ intin_ seconds - The AnomalyDetector period of detection and metric generation.
- labels
Sequence[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.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- arn String
- The AnomalyDetector ARN.
- configuration Property Map
- Determines the anomaly detector's algorithm and its configuration.
- 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.
Supporting Types
AnomalyDetectorConfiguration
- 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
AnomalyDetectorLabel
- 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
- 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
- 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
