AWS Native v0.77.0, Sep 20 23

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.cloudwatch.getAlarm

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

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:cloudwatch:getAlarm
  arguments:
    # arguments dictionary

The following arguments are supported:

AlarmName string: The name of the alarm.

AlarmName string: The name of the alarm.

alarmName String: The name of the alarm.

alarmName string: The name of the alarm.

alarm_name str: The name of the alarm.

alarmName String: The name of the alarm.

getAlarm Result

The following output properties are available:

ActionsEnabled bool: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
AlarmActions List<string>: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
AlarmDescription string: The description of the alarm.
Arn string: Amazon Resource Name is a unique name for each resource.
ComparisonOperator string: The arithmetic operation to use when comparing the specified statistic and threshold.
DatapointsToAlarm int: The number of datapoints that must be breaching to trigger the alarm.
Dimensions List<Pulumi.AwsNative.CloudWatch.Outputs.AlarmDimension>: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
EvaluateLowSampleCountPercentile string: Used only for alarms based on percentiles.
EvaluationPeriods int: The number of periods over which data is compared to the specified threshold.
ExtendedStatistic string: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
InsufficientDataActions List<string>: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
MetricName string: The name of the metric associated with the alarm.
Metrics List<Pulumi.AwsNative.CloudWatch.Outputs.AlarmMetricDataQuery>: An array that enables you to create an alarm based on the result of a metric math expression.
Namespace string: The namespace of the metric associated with the alarm.
OkActions List<string>: The actions to execute when this alarm transitions to the OK state from any other state.
Period int: The period in seconds, over which the statistic is applied.
Statistic string: The statistic for the metric associated with the alarm, other than percentile.
Threshold double: In 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.
ThresholdMetricId string: In 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.
TreatMissingData string: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
Unit string: The unit of the metric associated with the alarm.

ActionsEnabled bool: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
AlarmActions []string: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
AlarmDescription string: The description of the alarm.
Arn string: Amazon Resource Name is a unique name for each resource.
ComparisonOperator string: The arithmetic operation to use when comparing the specified statistic and threshold.
DatapointsToAlarm int: The number of datapoints that must be breaching to trigger the alarm.
Dimensions []AlarmDimension: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
EvaluateLowSampleCountPercentile string: Used only for alarms based on percentiles.
EvaluationPeriods int: The number of periods over which data is compared to the specified threshold.
ExtendedStatistic string: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
InsufficientDataActions []string: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
MetricName string: The name of the metric associated with the alarm.
Metrics []AlarmMetricDataQuery: An array that enables you to create an alarm based on the result of a metric math expression.
Namespace string: The namespace of the metric associated with the alarm.
OkActions []string: The actions to execute when this alarm transitions to the OK state from any other state.
Period int: The period in seconds, over which the statistic is applied.
Statistic string: The statistic for the metric associated with the alarm, other than percentile.
Threshold float64: In 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.
ThresholdMetricId string: In 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.
TreatMissingData string: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
Unit string: The unit of the metric associated with the alarm.

actionsEnabled Boolean: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
alarmActions List<String>: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
alarmDescription String: The description of the alarm.
arn String: Amazon Resource Name is a unique name for each resource.
comparisonOperator String: The arithmetic operation to use when comparing the specified statistic and threshold.
datapointsToAlarm Integer: The number of datapoints that must be breaching to trigger the alarm.
dimensions List<AlarmDimension>: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
evaluateLowSampleCountPercentile String: Used only for alarms based on percentiles.
evaluationPeriods Integer: The number of periods over which data is compared to the specified threshold.
extendedStatistic String: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficientDataActions List<String>: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
metricName String: The name of the metric associated with the alarm.
metrics List<AlarmMetricDataQuery>: An array that enables you to create an alarm based on the result of a metric math expression.
namespace String: The namespace of the metric associated with the alarm.
okActions List<String>: The actions to execute when this alarm transitions to the OK state from any other state.
period Integer: The period in seconds, over which the statistic is applied.
statistic String: The statistic for the metric associated with the alarm, other than percentile.
threshold Double: In 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.
thresholdMetricId String: In 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.
treatMissingData String: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
unit String: The unit of the metric associated with the alarm.

actionsEnabled boolean: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
alarmActions string[]: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
alarmDescription string: The description of the alarm.
arn string: Amazon Resource Name is a unique name for each resource.
comparisonOperator string: The arithmetic operation to use when comparing the specified statistic and threshold.
datapointsToAlarm number: The number of datapoints that must be breaching to trigger the alarm.
dimensions AlarmDimension[]: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
evaluateLowSampleCountPercentile string: Used only for alarms based on percentiles.
evaluationPeriods number: The number of periods over which data is compared to the specified threshold.
extendedStatistic string: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficientDataActions string[]: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
metricName string: The name of the metric associated with the alarm.
metrics AlarmMetricDataQuery[]: An array that enables you to create an alarm based on the result of a metric math expression.
namespace string: The namespace of the metric associated with the alarm.
okActions string[]: The actions to execute when this alarm transitions to the OK state from any other state.
period number: The period in seconds, over which the statistic is applied.
statistic string: The statistic for the metric associated with the alarm, other than percentile.
threshold number: In 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.
thresholdMetricId string: In 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.
treatMissingData string: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
unit string: The unit of the metric associated with the alarm.

actions_enabled bool: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
alarm_actions Sequence[str]: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
alarm_description str: The description of the alarm.
arn str: Amazon Resource Name is a unique name for each resource.
comparison_operator str: The arithmetic operation to use when comparing the specified statistic and threshold.
datapoints_to_alarm int: The number of datapoints that must be breaching to trigger the alarm.
dimensions Sequence[AlarmDimension]: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
evaluate_low_sample_count_percentile str: Used only for alarms based on percentiles.
evaluation_periods int: The number of periods over which data is compared to the specified threshold.
extended_statistic str: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficient_data_actions Sequence[str]: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
metric_name str: The name of the metric associated with the alarm.
metrics Sequence[AlarmMetricDataQuery]: An array that enables you to create an alarm based on the result of a metric math expression.
namespace str: The namespace of the metric associated with the alarm.
ok_actions Sequence[str]: The actions to execute when this alarm transitions to the OK state from any other state.
period int: The period in seconds, over which the statistic is applied.
statistic str: The statistic for the metric associated with the alarm, other than percentile.
threshold float: In 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.
threshold_metric_id str: In 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.
treat_missing_data str: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
unit str: The unit of the metric associated with the alarm.

actionsEnabled Boolean: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
alarmActions List<String>: The list of actions to execute when this alarm transitions into an ALARM state from any other state.
alarmDescription String: The description of the alarm.
arn String: Amazon Resource Name is a unique name for each resource.
comparisonOperator String: The arithmetic operation to use when comparing the specified statistic and threshold.
datapointsToAlarm Number: The number of datapoints that must be breaching to trigger the alarm.
dimensions List<Property Map>: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.
evaluateLowSampleCountPercentile String: Used only for alarms based on percentiles.
evaluationPeriods Number: The number of periods over which data is compared to the specified threshold.
extendedStatistic String: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficientDataActions List<String>: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
metricName String: The name of the metric associated with the alarm.
metrics List<Property Map>: An array that enables you to create an alarm based on the result of a metric math expression.
namespace String: The namespace of the metric associated with the alarm.
okActions List<String>: The actions to execute when this alarm transitions to the OK state from any other state.
period Number: The period in seconds, over which the statistic is applied.
statistic String: The statistic for the metric associated with the alarm, other than percentile.
threshold Number: In 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.
thresholdMetricId String: In 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.
treatMissingData String: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.
unit String: The unit of the metric associated with the alarm.

Supporting Types

AlarmDimension

Name string: The name of the dimension.
Value string: The value for the dimension.

Name string: The name of the dimension.
Value string: The value for the dimension.

name String: The name of the dimension.
value String: The value for the dimension.

name string: The name of the dimension.
value string: The value for the dimension.

name str: The name of the dimension.
value str: The value for the dimension.

name String: The name of the dimension.
value String: The value for the dimension.

AlarmMetric

Dimensions List<Pulumi.AwsNative.CloudWatch.Inputs.AlarmDimension>: The dimensions for the metric.
MetricName string: The name of the metric.
Namespace string: The namespace of the metric.

Dimensions []AlarmDimension: The dimensions for the metric.
MetricName string: The name of the metric.
Namespace string: The namespace of the metric.

dimensions List<AlarmDimension>: The dimensions for the metric.
metricName String: The name of the metric.
namespace String: The namespace of the metric.

dimensions AlarmDimension[]: The dimensions for the metric.
metricName string: The name of the metric.
namespace string: The namespace of the metric.

dimensions Sequence[AlarmDimension]: The dimensions for the metric.
metric_name str: The name of the metric.
namespace str: The namespace of the metric.

dimensions List<Property Map>: The dimensions for the metric.
metricName String: The name of the metric.
namespace String: The namespace of the metric.

AlarmMetricDataQuery

Id string: A short name used to tie this object to the results in the response.
AccountId string: The ID of the account where the metrics are located, if this is a cross-account alarm.
Expression string: The math expression to be performed on the returned data.
Label string: A human-readable label for this metric or expression.
MetricStat Pulumi.AwsNative.CloudWatch.Inputs.AlarmMetricStat: The metric to be returned, along with statistics, period, and units.
Period int: The period in seconds, over which the statistic is applied.
ReturnData bool: This option indicates whether to return the timestamps and raw data values of this metric.

Id string: A short name used to tie this object to the results in the response.
AccountId string: The ID of the account where the metrics are located, if this is a cross-account alarm.
Expression string: The math expression to be performed on the returned data.
Label string: A human-readable label for this metric or expression.
MetricStat AlarmMetricStat: The metric to be returned, along with statistics, period, and units.
Period int: The period in seconds, over which the statistic is applied.
ReturnData bool: This option indicates whether to return the timestamps and raw data values of this metric.

id String: A short name used to tie this object to the results in the response.
accountId String: The ID of the account where the metrics are located, if this is a cross-account alarm.
expression String: The math expression to be performed on the returned data.
label String: A human-readable label for this metric or expression.
metricStat AlarmMetricStat: The metric to be returned, along with statistics, period, and units.
period Integer: The period in seconds, over which the statistic is applied.
returnData Boolean: This option indicates whether to return the timestamps and raw data values of this metric.

id string: A short name used to tie this object to the results in the response.
accountId string: The ID of the account where the metrics are located, if this is a cross-account alarm.
expression string: The math expression to be performed on the returned data.
label string: A human-readable label for this metric or expression.
metricStat AlarmMetricStat: The metric to be returned, along with statistics, period, and units.
period number: The period in seconds, over which the statistic is applied.
returnData boolean: This option indicates whether to return the timestamps and raw data values of this metric.

id str: A short name used to tie this object to the results in the response.
account_id str: The ID of the account where the metrics are located, if this is a cross-account alarm.
expression str: The math expression to be performed on the returned data.
label str: A human-readable label for this metric or expression.
metric_stat AlarmMetricStat: The metric to be returned, along with statistics, period, and units.
period int: The period in seconds, over which the statistic is applied.
return_data bool: This option indicates whether to return the timestamps and raw data values of this metric.

id String: A short name used to tie this object to the results in the response.
accountId String: The ID of the account where the metrics are located, if this is a cross-account alarm.
expression String: The math expression to be performed on the returned data.
label String: A human-readable label for this metric or expression.
metricStat Property Map: The metric to be returned, along with statistics, period, and units.
period Number: The period in seconds, over which the statistic is applied.
returnData Boolean: This option indicates whether to return the timestamps and raw data values of this metric.

AlarmMetricStat

Metric Pulumi.AwsNative.CloudWatch.Inputs.AlarmMetric: The metric to return, including the metric name, namespace, and dimensions.
Period int: The granularity, in seconds, of the returned data points.
Stat string: The statistic to return.
Unit string: The unit to use for the returned data points.

Metric AlarmMetric: The metric to return, including the metric name, namespace, and dimensions.
Period int: The granularity, in seconds, of the returned data points.
Stat string: The statistic to return.
Unit string: The unit to use for the returned data points.

metric AlarmMetric: The metric to return, including the metric name, namespace, and dimensions.
period Integer: The granularity, in seconds, of the returned data points.
stat String: The statistic to return.
unit String: The unit to use for the returned data points.

metric AlarmMetric: The metric to return, including the metric name, namespace, and dimensions.
period number: The granularity, in seconds, of the returned data points.
stat string: The statistic to return.
unit string: The unit to use for the returned data points.

metric AlarmMetric: The metric to return, including the metric name, namespace, and dimensions.
period int: The granularity, in seconds, of the returned data points.
stat str: The statistic to return.
unit str: The unit to use for the returned data points.

metric Property Map: The metric to return, including the metric name, namespace, and dimensions.
period Number: The granularity, in seconds, of the returned data points.
stat String: The statistic to return.
unit String: The unit to use for the returned data points.

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.cloudwatch.getAlarm

On this page

On this page

Using getAlarm

getAlarm Result

Supporting Types

AlarmDimension

AlarmMetric

AlarmMetricDataQuery

AlarmMetricStat

Package Details

On this page

On this page