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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabledBoolean

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

Returns:

  • (Boolean)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_actionsArray<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>)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_arnString

The ARN of the alarm.

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_timestampString

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

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_descriptionString

The description of the alarm.

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_nameString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_operatorString

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

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_alarmInteger

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

Returns:

  • (Integer)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#dimensionsArray<Types::AwsCloudWatchAlarmDimensionsDetails>

The dimensions for the metric associated with the alarm.



4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_percentileString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_periodsInteger

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

Returns:

  • (Integer)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_statisticString

The percentile statistic for the metric associated with the alarm.

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_actionsArray<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>)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_nameString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#namespaceString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_actionsArray<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>)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#periodInteger

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

Returns:

  • (Integer)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#statisticString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#thresholdFloat

The value to compare with the specified statistic.

Returns:

  • (Float)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_idString

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)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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_dataString

Sets how this alarm is to handle missing data points.

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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

#unitString

The unit of the metric associated with the alarm.

Returns:

  • (String)


4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 4653

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