Struct aws_sdk_lightsail::client::fluent_builders::TestAlarm

pub struct TestAlarm<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to TestAlarm.

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Implementations

impl<C, M, R> TestAlarm<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<TestAlarmOutput, SdkError<TestAlarmError>> where
    R::Policy: SmithyRetryPolicy<TestAlarmInputOperationOutputAlias, TestAlarmOutput, TestAlarmError, TestAlarmInputOperationRetryAlias>, 

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 to test.

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

The name of the alarm to test.

pub fn state(self, input: AlarmState) -> Self

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

pub fn set_state(self, input: Option<AlarmState>) -> Self

The alarm state to test.

An alarm has the following possible states that can be tested:

• ALARM - The metric is outside of the defined threshold.

• INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

• OK - The metric is within the defined threshold.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for TestAlarm<C, M, R>

fn clone(&self) -> TestAlarm<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for TestAlarm<C, M, R>

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

Formats the value using the given formatter.