Package software.amazon.awscdk.services.logs

Class CfnLogAnomalyDetector.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnLogAnomalyDetector.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLogAnomalyDetector>

Enclosing class:

CfnLogAnomalyDetector

@Stability(Stable)
public static final class CfnLogAnomalyDetector.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLogAnomalyDetector>

A fluent builder for CfnLogAnomalyDetector.

Method Summary

Modifier and Type	Method	Description
CfnLogAnomalyDetector.Builder	accountId(String accountId)	The ID of the account to create the anomaly detector in.
CfnLogAnomalyDetector.Builder	anomalyVisibilityTime(Number anomalyVisibilityTime)	The number of days to have visibility on an anomaly.
CfnLogAnomalyDetector	build()
static CfnLogAnomalyDetector.Builder	create(software.constructs.Construct scope, String id)
CfnLogAnomalyDetector.Builder	detectorName(String detectorName)	A name for this anomaly detector.
CfnLogAnomalyDetector.Builder	evaluationFrequency(String evaluationFrequency)	Specifies how often the anomaly detector is to run and look for anomalies.
CfnLogAnomalyDetector.Builder	filterPattern(String filterPattern)	You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here.
CfnLogAnomalyDetector.Builder	kmsKeyId(String kmsKeyId)	Optionally assigns a AWS KMS key to secure this anomaly detector and its findings.
CfnLogAnomalyDetector.Builder	logGroupArnList(List<String> logGroupArnList)	The ARN of the log group that is associated with this anomaly detector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLogAnomalyDetector.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLogAnomalyDetector.Builder.

accountId

@Stability(Stable)
public CfnLogAnomalyDetector.Builder accountId(String accountId)

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

Parameters:

accountId - The ID of the account to create the anomaly detector in. This parameter is required.

Returns:

this

See Also:

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

anomalyVisibilityTime

@Stability(Stable)
public CfnLogAnomalyDetector.Builder anomalyVisibilityTime(Number anomalyVisibilityTime)

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.

Parameters:

anomalyVisibilityTime - The number of days to have visibility on an anomaly. This parameter is required.

Returns:

this

See Also:

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

detectorName

@Stability(Stable)
public CfnLogAnomalyDetector.Builder detectorName(String detectorName)

A name for this anomaly detector.

Parameters:

detectorName - A name for this anomaly detector. This parameter is required.

Returns:

this

See Also:

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

evaluationFrequency

@Stability(Stable)
public CfnLogAnomalyDetector.Builder evaluationFrequency(String evaluationFrequency)

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 .

Parameters:

evaluationFrequency - Specifies how often the anomaly detector is to run and look for anomalies. This parameter is required.

Returns:

this

See Also:

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

filterPattern

@Stability(Stable)
public CfnLogAnomalyDetector.Builder filterPattern(String filterPattern)

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 .

Parameters:

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

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnLogAnomalyDetector.Builder kmsKeyId(String kmsKeyId)

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 .

Parameters:

kmsKeyId - Optionally assigns a AWS KMS key to secure this anomaly detector and its findings. This parameter is required.

Returns:

this

See Also:

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

logGroupArnList

@Stability(Stable)
public CfnLogAnomalyDetector.Builder logGroupArnList(List<String> logGroupArnList)

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

You can specify only one log group ARN.

Parameters:

logGroupArnList - The ARN of the log group that is associated with this anomaly detector. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLogAnomalyDetector build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLogAnomalyDetector>

Returns:

a newly built instance of CfnLogAnomalyDetector.