aws-cdk-lib.aws_logs.CfnLogAnomalyDetectorProps

CfnLogAnomalyDetectorProps Struct

Properties for defining a CfnLogAnomalyDetector.

CfnLogAnomalyDetectorProps

used as props by

• CfnLogAnomalyDetector

Source

Generated code

Type last changed

v2.112.0 · 1 Dec 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const cfnLogAnomalyDetectorProps: logs.CfnLogAnomalyDetectorProps = {
  accountId: 'accountId',
  anomalyVisibilityTime: 123,
  detectorName: 'detectorName',
  evaluationFrequency: 'evaluationFrequency',
  filterPattern: 'filterPattern',
  kmsKeyId: 'kmsKeyId',
  logGroupArnList: ['logGroupArnList'],
};

Properties

accountId?optionalstringaccount_id?optionalstraccountId?optionalStringAccountId?optionalstringAccountId?optional*string#

The ID of the account to create the anomaly detector in.

anomalyVisibilityTime?optionalnumberanomaly_visibility_time?optionalint | floatanomalyVisibilityTime?optionalNumberAnomalyVisibilityTime?optionaldoubleAnomalyVisibilityTime?optional*float64#

The number of days to have visibility on an anomaly.

notes

After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in AnomalyVisibilityTime , it will be considered normal going forward and will not be detected as an anomaly.

detectorName?optionalstringdetector_name?optionalstrdetectorName?optionalStringDetectorName?optionalstringDetectorName?optional*string#

A name for this anomaly detector.

evaluationFrequency?optionalstringevaluation_frequency?optionalstrevaluationFrequency?optionalStringEvaluationFrequency?optionalstringEvaluationFrequency?optional*string#

Specifies how often the anomaly detector is to run and look for anomalies.

Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for EvaluationFrequency .

filterPattern?optionalstringfilter_pattern?optionalstrfilterPattern?optionalStringFilterPattern?optionalstringFilterPattern?optional*string#

You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here.

For more information, see Filter and Pattern Syntax .

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*string#

Optionally assigns a AWS key to secure this anomaly detector and its findings.

notes

If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

For more information about using a AWS key and to see the required IAM policy, see Use a AWS key with an anomaly detector .

logGroupArnList?optionalstring[]log_group_arn_list?optionaltyping.List[str]logGroupArnList?optionalList<String>LogGroupArnList?optionalstring[]LogGroupArnList?optional*[]*string#

The ARN of the log group that is associated with this anomaly detector.

You can specify only one log group ARN.