Class: Aws::SecurityHub::Types::AwsCloudWatchAlarmDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsCloudWatchAlarmDetails

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

Specifies an alarm and associates it with the specified metric or metric math expression.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions_enabled ⇒ Boolean

  Indicates whether actions should be executed during any changes to the alarm state.

• #alarm_actions ⇒ Array<String>

  The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ‘ALARM` state from any other state.

• #alarm_arn ⇒ String

  The ARN of the alarm.

• #alarm_configuration_updated_timestamp ⇒ String

  The time stamp of the last update to the alarm configuration.

• #alarm_description ⇒ String

  The description of the alarm.

• #alarm_name ⇒ String

  The name of the alarm.

• #comparison_operator ⇒ String

  The arithmetic operation to use when comparing the specified statistic and threshold.

• #datapoints_to_alarm ⇒ Integer

  The number of datapoints that must be breaching to trigger the alarm.

• #dimensions ⇒ Array<Types::AwsCloudWatchAlarmDimensionsDetails>

  The dimensions for the metric associated with the alarm.

• #evaluate_low_sample_count_percentile ⇒ String

  Used only for alarms based on percentiles.

• #evaluation_periods ⇒ Integer

  The number of periods over which data is compared to the specified threshold.

• #extended_statistic ⇒ String

  The percentile statistic for the metric associated with the alarm.

• #insufficient_data_actions ⇒ Array<String>

  The actions to execute when this alarm transitions to the ‘INSUFFICIENT_DATA` state from any other state.

• #metric_name ⇒ String

  The name of the metric associated with the alarm.

• #namespace ⇒ String

  The namespace of the metric associated with the alarm.

• #ok_actions ⇒ Array<String>

  The actions to execute when this alarm transitions to the ‘OK` state from any other state.

• #period ⇒ Integer

  The period, in seconds, over which the statistic is applied.

• #statistic ⇒ String

  The statistic for the metric associated with the alarm, other than percentile.

• #threshold ⇒ Float

  The value to compare with the specified statistic.

• #threshold_metric_id ⇒ String

  n an alarm based on an anomaly detection model, this is the ID of the ‘ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.

• #treat_missing_data ⇒ String

  Sets how this alarm is to handle missing data points.

• #unit ⇒ String

  The unit of the metric associated with the alarm.

Instance Attribute Details

#actions_enabled ⇒ Boolean

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

• (Boolean)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_actions ⇒ Array<String>

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ‘ALARM` state from any other state.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_arn ⇒ String

The ARN of the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_configuration_updated_timestamp ⇒ String

The time stamp of the last update to the alarm configuration.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_description ⇒ String

The description of the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_name ⇒ String

The name of the alarm. If you don’t specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#comparison_operator ⇒ String

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#datapoints_to_alarm ⇒ Integer

The number of datapoints that must be breaching to trigger the alarm.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::AwsCloudWatchAlarmDimensionsDetails>

The dimensions for the metric associated with the alarm.

Returns:

• (Array<Types::AwsCloudWatchAlarmDimensionsDetails>)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#evaluate_low_sample_count_percentile ⇒ String

Used only for alarms based on percentiles. If ‘ignore`, the alarm state does not change during periods with too few data points to be statistically significant. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_periods ⇒ Integer

The number of periods over which data is compared to the specified threshold.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#extended_statistic ⇒ String

The percentile statistic for the metric associated with the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#insufficient_data_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ‘INSUFFICIENT_DATA` state from any other state. Each action is specified as an ARN.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ‘Metrics` instead and you can’t specify ‘MetricName`.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can’t specify ‘Namespace` and you use `Metrics` instead.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#ok_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ‘OK` state from any other state. Each action is specified as an ARN.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

Returns:

• (Integer)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ String

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ‘ExtendedStatistic`.

For an alarm based on a metric, you must specify either ‘Statistic` or `ExtendedStatistic` but not both.

For an alarm based on a math expression, you can’t specify ‘Statistic`. Instead, you use `Metrics`.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#threshold ⇒ Float

The value to compare with the specified statistic.

Returns:

• (Float)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#threshold_metric_id ⇒ String

n an alarm based on an anomaly detection model, this is the ID of the ‘ANOMALY_DETECTION_BAND` function used as the threshold for the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#treat_missing_data ⇒ String

Sets how this alarm is to handle missing data points.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The unit of the metric associated with the alarm.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 4883

class AwsCloudWatchAlarmDetails < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :comparison_operator,
  :datapoints_to_alarm,
  :dimensions,
  :evaluate_low_sample_count_percentile,
  :evaluation_periods,
  :extended_statistic,
  :insufficient_data_actions,
  :metric_name,
  :namespace,
  :ok_actions,
  :period,
  :statistic,
  :threshold,
  :threshold_metric_id,
  :treat_missing_data,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end