software.amazon.awssdk.services.securityhub.model

Interface AwsCloudWatchAlarmDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsCloudWatchAlarmDetails.Builder,AwsCloudWatchAlarmDetails>, SdkBuilder<AwsCloudWatchAlarmDetails.Builder,AwsCloudWatchAlarmDetails>, SdkPojo

Enclosing class:

AwsCloudWatchAlarmDetails

public static interface AwsCloudWatchAlarmDetails.Builder
extends SdkPojo, CopyableBuilder<AwsCloudWatchAlarmDetails.Builder,AwsCloudWatchAlarmDetails>

Method Summary

Modifier and Type	Method and Description
AwsCloudWatchAlarmDetails.Builder	actionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state.
AwsCloudWatchAlarmDetails.Builder	alarmActions(Collection<String> alarmActions) The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.
AwsCloudWatchAlarmDetails.Builder	alarmActions(String... alarmActions) The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.
AwsCloudWatchAlarmDetails.Builder	alarmArn(String alarmArn) The ARN of the alarm.
AwsCloudWatchAlarmDetails.Builder	alarmConfigurationUpdatedTimestamp(String alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.
AwsCloudWatchAlarmDetails.Builder	alarmDescription(String alarmDescription) The description of the alarm.
AwsCloudWatchAlarmDetails.Builder	alarmName(String alarmName) The name of the alarm.
AwsCloudWatchAlarmDetails.Builder	comparisonOperator(String comparisonOperator) The arithmetic operation to use when comparing the specified statistic and threshold.
AwsCloudWatchAlarmDetails.Builder	datapointsToAlarm(Integer datapointsToAlarm) The number of datapoints that must be breaching to trigger the alarm.
AwsCloudWatchAlarmDetails.Builder	dimensions(AwsCloudWatchAlarmDimensionsDetails... dimensions) The dimensions for the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	dimensions(Collection<AwsCloudWatchAlarmDimensionsDetails> dimensions) The dimensions for the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	dimensions(Consumer<AwsCloudWatchAlarmDimensionsDetails.Builder>... dimensions) The dimensions for the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile) Used only for alarms based on percentiles.
AwsCloudWatchAlarmDetails.Builder	evaluationPeriods(Integer evaluationPeriods) The number of periods over which data is compared to the specified threshold.
AwsCloudWatchAlarmDetails.Builder	extendedStatistic(String extendedStatistic) The percentile statistic for the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	insufficientDataActions(Collection<String> insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
AwsCloudWatchAlarmDetails.Builder	insufficientDataActions(String... insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
AwsCloudWatchAlarmDetails.Builder	metricName(String metricName) The name of the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	namespace(String namespace) The namespace of the metric associated with the alarm.
AwsCloudWatchAlarmDetails.Builder	okActions(Collection<String> okActions) The actions to execute when this alarm transitions to the OK state from any other state.
AwsCloudWatchAlarmDetails.Builder	okActions(String... okActions) The actions to execute when this alarm transitions to the OK state from any other state.
AwsCloudWatchAlarmDetails.Builder	period(Integer period) The period, in seconds, over which the statistic is applied.
AwsCloudWatchAlarmDetails.Builder	statistic(String statistic) The statistic for the metric associated with the alarm, other than percentile.
AwsCloudWatchAlarmDetails.Builder	threshold(Double threshold) The value to compare with the specified statistic.
AwsCloudWatchAlarmDetails.Builder	thresholdMetricId(String thresholdMetricId) 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.
AwsCloudWatchAlarmDetails.Builder	treatMissingData(String treatMissingData) Sets how this alarm is to handle missing data points.
AwsCloudWatchAlarmDetails.Builder	unit(String unit) The unit of the metric associated with the alarm.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

actionsEnabled

AwsCloudWatchAlarmDetails.Builder actionsEnabled(Boolean actionsEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmActions

AwsCloudWatchAlarmDetails.Builder alarmActions(Collection<String> alarmActions)

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

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

alarmActions

AwsCloudWatchAlarmDetails.Builder alarmActions(String... alarmActions)

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

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

alarmArn

AwsCloudWatchAlarmDetails.Builder alarmArn(String alarmArn)

The ARN of the alarm.

Parameters:

alarmArn - The ARN of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmConfigurationUpdatedTimestamp

AwsCloudWatchAlarmDetails.Builder alarmConfigurationUpdatedTimestamp(String alarmConfigurationUpdatedTimestamp)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmDescription

AwsCloudWatchAlarmDetails.Builder alarmDescription(String alarmDescription)

The description of the alarm.

Parameters:

alarmDescription - The description of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmName

AwsCloudWatchAlarmDetails.Builder alarmName(String alarmName)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

comparisonOperator

AwsCloudWatchAlarmDetails.Builder comparisonOperator(String comparisonOperator)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

datapointsToAlarm

AwsCloudWatchAlarmDetails.Builder datapointsToAlarm(Integer datapointsToAlarm)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

AwsCloudWatchAlarmDetails.Builder dimensions(Collection<AwsCloudWatchAlarmDimensionsDetails> dimensions)

The dimensions for the metric associated with the alarm.

Parameters:

dimensions - The dimensions for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

AwsCloudWatchAlarmDetails.Builder dimensions(AwsCloudWatchAlarmDimensionsDetails... dimensions)

The dimensions for the metric associated with the alarm.

Parameters:

dimensions - The dimensions for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

AwsCloudWatchAlarmDetails.Builder dimensions(Consumer<AwsCloudWatchAlarmDimensionsDetails.Builder>... dimensions)

The dimensions for the metric associated with the alarm.

This is a convenience method that creates an instance of the AwsCloudWatchAlarmDimensionsDetails.Builder avoiding the need to create one manually via AwsCloudWatchAlarmDimensionsDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dimensions(List).

Parameters:

dimensions - a consumer that will call methods on AwsCloudWatchAlarmDimensionsDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#dimensions(java.util.Collection)

evaluateLowSampleCountPercentile

AwsCloudWatchAlarmDetails.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

evaluationPeriods

AwsCloudWatchAlarmDetails.Builder evaluationPeriods(Integer evaluationPeriods)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

extendedStatistic

AwsCloudWatchAlarmDetails.Builder extendedStatistic(String extendedStatistic)

The percentile statistic for the metric associated with the alarm.

Parameters:

extendedStatistic - The percentile statistic for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

insufficientDataActions

AwsCloudWatchAlarmDetails.Builder insufficientDataActions(Collection<String> insufficientDataActions)

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

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

insufficientDataActions

AwsCloudWatchAlarmDetails.Builder insufficientDataActions(String... insufficientDataActions)

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

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

metricName

AwsCloudWatchAlarmDetails.Builder metricName(String metricName)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

namespace

AwsCloudWatchAlarmDetails.Builder namespace(String namespace)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

okActions

AwsCloudWatchAlarmDetails.Builder okActions(Collection<String> okActions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

okActions

AwsCloudWatchAlarmDetails.Builder okActions(String... okActions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

period

AwsCloudWatchAlarmDetails.Builder period(Integer period)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

statistic

AwsCloudWatchAlarmDetails.Builder statistic(String statistic)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

threshold

AwsCloudWatchAlarmDetails.Builder threshold(Double threshold)

The value to compare with the specified statistic.

Parameters:

threshold - The value to compare with the specified statistic.

Returns:

Returns a reference to this object so that method calls can be chained together.

thresholdMetricId

AwsCloudWatchAlarmDetails.Builder thresholdMetricId(String thresholdMetricId)

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.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

treatMissingData

AwsCloudWatchAlarmDetails.Builder treatMissingData(String treatMissingData)

Sets how this alarm is to handle missing data points.

Parameters:

treatMissingData - Sets how this alarm is to handle missing data points.

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

AwsCloudWatchAlarmDetails.Builder unit(String unit)

The unit of the metric associated with the alarm.

Parameters:

unit - The unit of the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.