Header menu logo FsCDK

CloudWatchAlarmBuilder Type

Constructors

Constructor Description

CloudWatchAlarmBuilder(name)

Full Usage: CloudWatchAlarmBuilder(name)

Parameters:
    name : string

Returns: CloudWatchAlarmBuilder
name : string
Returns: CloudWatchAlarmBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: CloudWatchAlarmConfig
state1 : CloudWatchAlarmConfig
state2 : CloudWatchAlarmConfig
Returns: CloudWatchAlarmConfig

comparisonOperator op

Full Usage: comparisonOperator op

Parameters:
Returns: CloudWatchAlarmConfig

Sets the comparison operator.

op : ComparisonOperator
Returns: CloudWatchAlarmConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: CloudWatchAlarmConfig

Sets the construct ID for the alarm.

id : string
Returns: CloudWatchAlarmConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: CloudWatchAlarmConfig
Modifiers: inline
f : unit -> CloudWatchAlarmConfig
Returns: CloudWatchAlarmConfig

description desc

Full Usage: description desc

Parameters:
    desc : string

Returns: CloudWatchAlarmConfig

Sets the alarm description.

desc : string
Returns: CloudWatchAlarmConfig

dimensions dims

Full Usage: dimensions dims

Parameters:
    dims : (string * string) list

Returns: CloudWatchAlarmConfig

Sets the metric dimensions for filtering (e.g., FunctionName, DBInstanceIdentifier).

dims : (string * string) list
Returns: CloudWatchAlarmConfig

evaluationPeriods periods

Full Usage: evaluationPeriods periods

Parameters:
    periods : int

Returns: CloudWatchAlarmConfig

Sets the number of periods to evaluate.

periods : int
Returns: CloudWatchAlarmConfig

this.For

Full Usage: this.For

Parameters:
Returns: CloudWatchAlarmConfig
Modifiers: inline
config : CloudWatchAlarmConfig
f : unit -> CloudWatchAlarmConfig
Returns: CloudWatchAlarmConfig

metric metric

Full Usage: metric metric

Parameters:
Returns: CloudWatchAlarmConfig

Sets the IMetric. If you use this, don't define metricName or metricNamespace.

metric : IMetric
Returns: CloudWatchAlarmConfig

metricName name

Full Usage: metricName name

Parameters:
    name : string

Returns: CloudWatchAlarmConfig

Sets the metric name (e.g., "Errors", "CPUUtilization").

name : string
Returns: CloudWatchAlarmConfig

metricNamespace ns

Full Usage: metricNamespace ns

Parameters:
    ns : string

Returns: CloudWatchAlarmConfig

Sets the CloudWatch metric namespace (e.g., "AWS/Lambda", "AWS/RDS").

ns : string
Returns: CloudWatchAlarmConfig

period period

Full Usage: period period

Parameters:
Returns: CloudWatchAlarmConfig

Sets the evaluation period.

period : Duration
Returns: CloudWatchAlarmConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: CloudWatchAlarmSpec
config : CloudWatchAlarmConfig
Returns: CloudWatchAlarmSpec

statistic stat

Full Usage: statistic stat

Parameters:
    stat : string

Returns: CloudWatchAlarmConfig

Sets the statistic (Average, Sum, Minimum, Maximum, SampleCount).

stat : string
Returns: CloudWatchAlarmConfig

threshold threshold

Full Usage: threshold threshold

Parameters:
    threshold : float

Returns: CloudWatchAlarmConfig

Sets the alarm threshold value.

threshold : float
Returns: CloudWatchAlarmConfig

treatMissingData treatment

Full Usage: treatMissingData treatment

Parameters:
Returns: CloudWatchAlarmConfig

Sets how to treat missing data.

treatment : TreatMissingData
Returns: CloudWatchAlarmConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: CloudWatchAlarmConfig
() : unit
Returns: CloudWatchAlarmConfig

this.Zero

Full Usage: this.Zero

Returns: CloudWatchAlarmConfig
Returns: CloudWatchAlarmConfig

Type something to start searching.