Package software.amazon.awscdk.services.logs

Interface CfnLogAnomalyDetectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogAnomalyDetectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.573Z")
@Stability(Stable)
public interface CfnLogAnomalyDetectorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLogAnomalyDetector.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnLogAnomalyDetectorProps cfnLogAnomalyDetectorProps = CfnLogAnomalyDetectorProps.builder()
         .accountId("accountId")
         .anomalyVisibilityTime(123)
         .detectorName("detectorName")
         .evaluationFrequency("evaluationFrequency")
         .filterPattern("filterPattern")
         .kmsKeyId("kmsKeyId")
         .logGroupArnList(List.of("logGroupArnList"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLogAnomalyDetectorProps.Builder	A builder for CfnLogAnomalyDetectorProps
static final class	CfnLogAnomalyDetectorProps.Jsii$Proxy	An implementation for CfnLogAnomalyDetectorProps

Method Summary

Modifier and Type	Method	Description
static CfnLogAnomalyDetectorProps.Builder	builder()
default String	getAccountId()	The ID of the account to create the anomaly detector in.
default Number	getAnomalyVisibilityTime()	The number of days to have visibility on an anomaly.
default String	getDetectorName()	A name for this anomaly detector.
default String	getEvaluationFrequency()	Specifies how often the anomaly detector is to run and look for anomalies.
default String	getFilterPattern()	You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here.
default String	getKmsKeyId()	Optionally assigns a AWS KMS key to secure this anomaly detector and its findings.
default List<String>	getLogGroupArnList()	The ARN of the log group that is associated with this anomaly detector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountId

@Stability(Stable)
@Nullable
default String getAccountId()

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

See Also:

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

getAnomalyVisibilityTime

@Stability(Stable)
@Nullable
default Number getAnomalyVisibilityTime()

The number of days to have visibility on an anomaly.

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 Also:

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

getDetectorName

@Stability(Stable)
@Nullable
default String getDetectorName()

A name for this anomaly detector.

See Also:

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

getEvaluationFrequency

@Stability(Stable)
@Nullable
default String getEvaluationFrequency()

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 .

See Also:

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

getFilterPattern

@Stability(Stable)
@Nullable
default String getFilterPattern()

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 .

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

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 Also:

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

getLogGroupArnList

@Stability(Stable)
@Nullable
default List<String> getLogGroupArnList()

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

You can specify only one log group ARN.

See Also:

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

builder

@Stability(Stable)
static CfnLogAnomalyDetectorProps.Builder builder()

Returns:

a CfnLogAnomalyDetectorProps.Builder of CfnLogAnomalyDetectorProps