AWS Native v0.63.0, May 25 23

aws-native.lightsail.getAlarm

Explore with Pulumi AI

Resource Type definition for AWS::Lightsail::Alarm

Using getAlarm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlarm(args: GetAlarmArgs, opts?: InvokeOptions): Promise<GetAlarmResult>
function getAlarmOutput(args: GetAlarmOutputArgs, opts?: InvokeOptions): Output<GetAlarmResult>

def get_alarm(alarm_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAlarmResult
def get_alarm_output(alarm_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAlarmResult]

func LookupAlarm(ctx *Context, args *LookupAlarmArgs, opts ...InvokeOption) (*LookupAlarmResult, error)
func LookupAlarmOutput(ctx *Context, args *LookupAlarmOutputArgs, opts ...InvokeOption) LookupAlarmResultOutput

> Note: This function is named LookupAlarm in the Go SDK.

public static class GetAlarm 
{
    public static Task<GetAlarmResult> InvokeAsync(GetAlarmArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmResult> Invoke(GetAlarmInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlarmResult> getAlarm(GetAlarmArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:lightsail:getAlarm
  arguments:
    # arguments dictionary

The following arguments are supported:

AlarmName string: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

AlarmName string: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

alarmName String: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

alarmName string: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

alarm_name str: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

alarmName String: The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

getAlarm Result

The following output properties are available:

AlarmArn string
ComparisonOperator string: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
ContactProtocols List<string>: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
DatapointsToAlarm int: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
EvaluationPeriods int: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
NotificationEnabled bool: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
NotificationTriggers List<string>: The alarm states that trigger a notification.
State string: The current state of the alarm.
Threshold double: The value against which the specified statistic is compared.
TreatMissingData string: Sets how this alarm will handle missing data points.

AlarmArn string
ComparisonOperator string: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
ContactProtocols []string: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
DatapointsToAlarm int: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
EvaluationPeriods int: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
NotificationEnabled bool: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
NotificationTriggers []string: The alarm states that trigger a notification.
State string: The current state of the alarm.
Threshold float64: The value against which the specified statistic is compared.
TreatMissingData string: Sets how this alarm will handle missing data points.

alarmArn String
comparisonOperator String: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contactProtocols List<String>: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
datapointsToAlarm Integer: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
evaluationPeriods Integer: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
notificationEnabled Boolean: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notificationTriggers List<String>: The alarm states that trigger a notification.
state String: The current state of the alarm.
threshold Double: The value against which the specified statistic is compared.
treatMissingData String: Sets how this alarm will handle missing data points.

alarmArn string
comparisonOperator string: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contactProtocols string[]: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
datapointsToAlarm number: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
evaluationPeriods number: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
notificationEnabled boolean: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notificationTriggers string[]: The alarm states that trigger a notification.
state string: The current state of the alarm.
threshold number: The value against which the specified statistic is compared.
treatMissingData string: Sets how this alarm will handle missing data points.

alarm_arn str
comparison_operator str: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contact_protocols Sequence[str]: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
datapoints_to_alarm int: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
evaluation_periods int: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
notification_enabled bool: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notification_triggers Sequence[str]: The alarm states that trigger a notification.
state str: The current state of the alarm.
threshold float: The value against which the specified statistic is compared.
treat_missing_data str: Sets how this alarm will handle missing data points.

alarmArn String
comparisonOperator String: The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
contactProtocols List<String>: The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
datapointsToAlarm Number: The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
evaluationPeriods Number: The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
notificationEnabled Boolean: Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
notificationTriggers List<String>: The alarm states that trigger a notification.
state String: The current state of the alarm.
threshold Number: The value against which the specified statistic is compared.
treatMissingData String: Sets how this alarm will handle missing data points.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.lightsail.getAlarm

Using getAlarm

getAlarm Result

Package Details

On this page