Interface ICfnLogAnomalyDetectorProps

Properties for defining a CfnLogAnomalyDetector.

Namespace: Amazon.CDK.AWS.Logs

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnLogAnomalyDetectorProps

Syntax (vb)

Public Interface ICfnLogAnomalyDetectorProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Logs;

             var cfnLogAnomalyDetectorProps = new CfnLogAnomalyDetectorProps {
                 AccountId = "accountId",
                 AnomalyVisibilityTime = 123,
                 DetectorName = "detectorName",
                 EvaluationFrequency = "evaluationFrequency",
                 FilterPattern = "filterPattern",
                 KmsKeyId = "kmsKeyId",
                 LogGroupArnList = new [] { "logGroupArnList" }
             };

Synopsis

Properties

AccountId	The ID of the account to create the anomaly detector in.
AnomalyVisibilityTime	The number of days to have visibility on an anomaly.
DetectorName	A name for this anomaly detector.
EvaluationFrequency	Specifies how often the anomaly detector is to run and look for anomalies.
FilterPattern	You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here.
KmsKeyId	Optionally assigns a AWS KMS key to secure this anomaly detector and its findings.
LogGroupArnList	The ARN of the log group that is associated with this anomaly detector.

Properties

AccountId

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

string? AccountId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-accountid

AnomalyVisibilityTime

The number of days to have visibility on an anomaly.

double? AnomalyVisibilityTime { get; }

Property Value

double?

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-anomalyvisibilitytime

DetectorName

A name for this anomaly detector.

string? DetectorName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-detectorname

EvaluationFrequency

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

string? EvaluationFrequency { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-evaluationfrequency

FilterPattern

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

string? FilterPattern { get; }

Property Value

string

Remarks

For more information, see Filter and Pattern Syntax .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-filterpattern

KmsKeyId

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

string? KmsKeyId { get; }

Property Value

string

Remarks

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 KMS key and to see the required IAM policy, see Use a AWS KMS key with an anomaly detector .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-kmskeyid

LogGroupArnList

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

string[]? LogGroupArnList { get; }

Property Value

string[]

Remarks

You can specify only one log group ARN.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loganomalydetector.html#cfn-logs-loganomalydetector-loggrouparnlist