Class: Aws::CloudWatchLogs::Types::CreateLogAnomalyDetectorRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::CreateLogAnomalyDetectorRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #anomaly_visibility_time ⇒ Integer

  The number of days to have visibility on an anomaly.

• #detector_name ⇒ String

  A name for this anomaly detector.

• #evaluation_frequency ⇒ String

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

• #filter_pattern ⇒ String

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

• #kms_key_id ⇒ String

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

• #log_group_arn_list ⇒ Array<String>

  An array containing the ARN of the log group that this anomaly detector will watch.

• #tags ⇒ Hash<String,String>

  An optional list of key-value pairs to associate with the resource.

Instance Attribute Details

#anomaly_visibility_time ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#detector_name ⇒ String

A name for this anomaly detector.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_frequency ⇒ 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` .

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#filter_pattern ⇒ 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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_arn_list ⇒ Array<String>

An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see [Tagging Amazon Web Services resources]

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 696

class CreateLogAnomalyDetectorRequest < Struct.new(
  :log_group_arn_list,
  :detector_name,
  :evaluation_frequency,
  :filter_pattern,
  :kms_key_id,
  :anomaly_visibility_time,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end