Struct aws_sdk_cloudwatch::client::fluent_builders::SetAlarmState

pub struct SetAlarmState { /* private fields */ }

Fluent builder constructing a request to SetAlarmState.

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

Implementations

impl SetAlarmState

pub async fn send(
    self
) -> Result<SetAlarmStateOutput, SdkError<SetAlarmStateError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn alarm_name(self, input: impl Into<String>) -> Self

The name of the alarm.

pub fn set_alarm_name(self, input: Option<String>) -> Self

The name of the alarm.

pub fn state_value(self, input: StateValue) -> Self

The value of the state.

pub fn set_state_value(self, input: Option<StateValue>) -> Self

The value of the state.

pub fn state_reason(self, input: impl Into<String>) -> Self

The reason that this alarm is set to this specific state, in text format.

pub fn set_state_reason(self, input: Option<String>) -> Self

The reason that this alarm is set to this specific state, in text format.

pub fn state_reason_data(self, input: impl Into<String>) -> Self

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

pub fn set_state_reason_data(self, input: Option<String>) -> Self

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

Trait Implementations

impl Clone for SetAlarmState

fn clone(&self) -> SetAlarmState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetAlarmState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.