AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EMR::Model::CloudWatchAlarmDefinition Class Reference

#include <CloudWatchAlarmDefinition.h>

Public Member Functions

 CloudWatchAlarmDefinition ()
 
 CloudWatchAlarmDefinition (Aws::Utils::Json::JsonView jsonValue)
 
CloudWatchAlarmDefinitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ComparisonOperatorGetComparisonOperator () const
 
bool ComparisonOperatorHasBeenSet () const
 
void SetComparisonOperator (const ComparisonOperator &value)
 
void SetComparisonOperator (ComparisonOperator &&value)
 
CloudWatchAlarmDefinitionWithComparisonOperator (const ComparisonOperator &value)
 
CloudWatchAlarmDefinitionWithComparisonOperator (ComparisonOperator &&value)
 
int GetEvaluationPeriods () const
 
bool EvaluationPeriodsHasBeenSet () const
 
void SetEvaluationPeriods (int value)
 
CloudWatchAlarmDefinitionWithEvaluationPeriods (int value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
CloudWatchAlarmDefinitionWithMetricName (const Aws::String &value)
 
CloudWatchAlarmDefinitionWithMetricName (Aws::String &&value)
 
CloudWatchAlarmDefinitionWithMetricName (const char *value)
 
const Aws::StringGetNamespace () const
 
bool NamespaceHasBeenSet () const
 
void SetNamespace (const Aws::String &value)
 
void SetNamespace (Aws::String &&value)
 
void SetNamespace (const char *value)
 
CloudWatchAlarmDefinitionWithNamespace (const Aws::String &value)
 
CloudWatchAlarmDefinitionWithNamespace (Aws::String &&value)
 
CloudWatchAlarmDefinitionWithNamespace (const char *value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
CloudWatchAlarmDefinitionWithPeriod (int value)
 
const StatisticGetStatistic () const
 
bool StatisticHasBeenSet () const
 
void SetStatistic (const Statistic &value)
 
void SetStatistic (Statistic &&value)
 
CloudWatchAlarmDefinitionWithStatistic (const Statistic &value)
 
CloudWatchAlarmDefinitionWithStatistic (Statistic &&value)
 
double GetThreshold () const
 
bool ThresholdHasBeenSet () const
 
void SetThreshold (double value)
 
CloudWatchAlarmDefinitionWithThreshold (double value)
 
const UnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const Unit &value)
 
void SetUnit (Unit &&value)
 
CloudWatchAlarmDefinitionWithUnit (const Unit &value)
 
CloudWatchAlarmDefinitionWithUnit (Unit &&value)
 
const Aws::Vector< MetricDimension > & GetDimensions () const
 
bool DimensionsHasBeenSet () const
 
void SetDimensions (const Aws::Vector< MetricDimension > &value)
 
void SetDimensions (Aws::Vector< MetricDimension > &&value)
 
CloudWatchAlarmDefinitionWithDimensions (const Aws::Vector< MetricDimension > &value)
 
CloudWatchAlarmDefinitionWithDimensions (Aws::Vector< MetricDimension > &&value)
 
CloudWatchAlarmDefinitionAddDimensions (const MetricDimension &value)
 
CloudWatchAlarmDefinitionAddDimensions (MetricDimension &&value)
 

Detailed Description

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

See Also:

AWS API Reference

Definition at line 38 of file CloudWatchAlarmDefinition.h.

Constructor & Destructor Documentation

◆ CloudWatchAlarmDefinition() [1/2]

Aws::EMR::Model::CloudWatchAlarmDefinition::CloudWatchAlarmDefinition ( )

◆ CloudWatchAlarmDefinition() [2/2]

Aws::EMR::Model::CloudWatchAlarmDefinition::CloudWatchAlarmDefinition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDimensions() [1/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::AddDimensions ( const MetricDimension value)
inline

A CloudWatch metric dimension.

Definition at line 374 of file CloudWatchAlarmDefinition.h.

◆ AddDimensions() [2/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::AddDimensions ( MetricDimension &&  value)
inline

A CloudWatch metric dimension.

Definition at line 379 of file CloudWatchAlarmDefinition.h.

◆ ComparisonOperatorHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::ComparisonOperatorHasBeenSet ( ) const
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 57 of file CloudWatchAlarmDefinition.h.

◆ DimensionsHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::DimensionsHasBeenSet ( ) const
inline

A CloudWatch metric dimension.

Definition at line 349 of file CloudWatchAlarmDefinition.h.

◆ EvaluationPeriodsHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::EvaluationPeriodsHasBeenSet ( ) const
inline

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Definition at line 96 of file CloudWatchAlarmDefinition.h.

◆ GetComparisonOperator()

const ComparisonOperator& Aws::EMR::Model::CloudWatchAlarmDefinition::GetComparisonOperator ( ) const
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 51 of file CloudWatchAlarmDefinition.h.

◆ GetDimensions()

const Aws::Vector<MetricDimension>& Aws::EMR::Model::CloudWatchAlarmDefinition::GetDimensions ( ) const
inline

A CloudWatch metric dimension.

Definition at line 344 of file CloudWatchAlarmDefinition.h.

◆ GetEvaluationPeriods()

int Aws::EMR::Model::CloudWatchAlarmDefinition::GetEvaluationPeriods ( ) const
inline

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Definition at line 89 of file CloudWatchAlarmDefinition.h.

◆ GetMetricName()

const Aws::String& Aws::EMR::Model::CloudWatchAlarmDefinition::GetMetricName ( ) const
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 117 of file CloudWatchAlarmDefinition.h.

◆ GetNamespace()

const Aws::String& Aws::EMR::Model::CloudWatchAlarmDefinition::GetNamespace ( ) const
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 166 of file CloudWatchAlarmDefinition.h.

◆ GetPeriod()

int Aws::EMR::Model::CloudWatchAlarmDefinition::GetPeriod ( ) const
inline

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Definition at line 216 of file CloudWatchAlarmDefinition.h.

◆ GetStatistic()

const Statistic& Aws::EMR::Model::CloudWatchAlarmDefinition::GetStatistic ( ) const
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 244 of file CloudWatchAlarmDefinition.h.

◆ GetThreshold()

double Aws::EMR::Model::CloudWatchAlarmDefinition::GetThreshold ( ) const
inline

The value against which the specified statistic is compared.

Definition at line 280 of file CloudWatchAlarmDefinition.h.

◆ GetUnit()

const Unit& Aws::EMR::Model::CloudWatchAlarmDefinition::GetUnit ( ) const
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 303 of file CloudWatchAlarmDefinition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EMR::Model::CloudWatchAlarmDefinition::Jsonize ( ) const

◆ MetricNameHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::MetricNameHasBeenSet ( ) const
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 123 of file CloudWatchAlarmDefinition.h.

◆ NamespaceHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::NamespaceHasBeenSet ( ) const
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 172 of file CloudWatchAlarmDefinition.h.

◆ operator=()

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PeriodHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::PeriodHasBeenSet ( ) const
inline

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Definition at line 223 of file CloudWatchAlarmDefinition.h.

◆ SetComparisonOperator() [1/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetComparisonOperator ( const ComparisonOperator value)
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 63 of file CloudWatchAlarmDefinition.h.

◆ SetComparisonOperator() [2/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetComparisonOperator ( ComparisonOperator &&  value)
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 69 of file CloudWatchAlarmDefinition.h.

◆ SetDimensions() [1/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetDimensions ( const Aws::Vector< MetricDimension > &  value)
inline

A CloudWatch metric dimension.

Definition at line 354 of file CloudWatchAlarmDefinition.h.

◆ SetDimensions() [2/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetDimensions ( Aws::Vector< MetricDimension > &&  value)
inline

A CloudWatch metric dimension.

Definition at line 359 of file CloudWatchAlarmDefinition.h.

◆ SetEvaluationPeriods()

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetEvaluationPeriods ( int  value)
inline

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Definition at line 103 of file CloudWatchAlarmDefinition.h.

◆ SetMetricName() [1/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetMetricName ( const Aws::String value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 129 of file CloudWatchAlarmDefinition.h.

◆ SetMetricName() [2/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetMetricName ( Aws::String &&  value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 135 of file CloudWatchAlarmDefinition.h.

◆ SetMetricName() [3/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetMetricName ( const char *  value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 141 of file CloudWatchAlarmDefinition.h.

◆ SetNamespace() [1/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetNamespace ( const Aws::String value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 178 of file CloudWatchAlarmDefinition.h.

◆ SetNamespace() [2/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetNamespace ( Aws::String &&  value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 184 of file CloudWatchAlarmDefinition.h.

◆ SetNamespace() [3/3]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetNamespace ( const char *  value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 190 of file CloudWatchAlarmDefinition.h.

◆ SetPeriod()

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetPeriod ( int  value)
inline

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Definition at line 230 of file CloudWatchAlarmDefinition.h.

◆ SetStatistic() [1/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetStatistic ( const Statistic value)
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 256 of file CloudWatchAlarmDefinition.h.

◆ SetStatistic() [2/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetStatistic ( Statistic &&  value)
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 262 of file CloudWatchAlarmDefinition.h.

◆ SetThreshold()

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetThreshold ( double  value)
inline

The value against which the specified statistic is compared.

Definition at line 290 of file CloudWatchAlarmDefinition.h.

◆ SetUnit() [1/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetUnit ( const Unit value)
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 317 of file CloudWatchAlarmDefinition.h.

◆ SetUnit() [2/2]

void Aws::EMR::Model::CloudWatchAlarmDefinition::SetUnit ( Unit &&  value)
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 324 of file CloudWatchAlarmDefinition.h.

◆ StatisticHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::StatisticHasBeenSet ( ) const
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 250 of file CloudWatchAlarmDefinition.h.

◆ ThresholdHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::ThresholdHasBeenSet ( ) const
inline

The value against which the specified statistic is compared.

Definition at line 285 of file CloudWatchAlarmDefinition.h.

◆ UnitHasBeenSet()

bool Aws::EMR::Model::CloudWatchAlarmDefinition::UnitHasBeenSet ( ) const
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 310 of file CloudWatchAlarmDefinition.h.

◆ WithComparisonOperator() [1/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithComparisonOperator ( const ComparisonOperator value)
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 75 of file CloudWatchAlarmDefinition.h.

◆ WithComparisonOperator() [2/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithComparisonOperator ( ComparisonOperator &&  value)
inline

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Definition at line 81 of file CloudWatchAlarmDefinition.h.

◆ WithDimensions() [1/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithDimensions ( const Aws::Vector< MetricDimension > &  value)
inline

A CloudWatch metric dimension.

Definition at line 364 of file CloudWatchAlarmDefinition.h.

◆ WithDimensions() [2/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithDimensions ( Aws::Vector< MetricDimension > &&  value)
inline

A CloudWatch metric dimension.

Definition at line 369 of file CloudWatchAlarmDefinition.h.

◆ WithEvaluationPeriods()

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithEvaluationPeriods ( int  value)
inline

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Definition at line 110 of file CloudWatchAlarmDefinition.h.

◆ WithMetricName() [1/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithMetricName ( const Aws::String value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 147 of file CloudWatchAlarmDefinition.h.

◆ WithMetricName() [2/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithMetricName ( Aws::String &&  value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 153 of file CloudWatchAlarmDefinition.h.

◆ WithMetricName() [3/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithMetricName ( const char *  value)
inline

The name of the CloudWatch metric that is watched to determine an alarm condition.

Definition at line 159 of file CloudWatchAlarmDefinition.h.

◆ WithNamespace() [1/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithNamespace ( const Aws::String value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 196 of file CloudWatchAlarmDefinition.h.

◆ WithNamespace() [2/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithNamespace ( Aws::String &&  value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 202 of file CloudWatchAlarmDefinition.h.

◆ WithNamespace() [3/3]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithNamespace ( const char *  value)
inline

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Definition at line 208 of file CloudWatchAlarmDefinition.h.

◆ WithPeriod()

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithPeriod ( int  value)
inline

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Definition at line 237 of file CloudWatchAlarmDefinition.h.

◆ WithStatistic() [1/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithStatistic ( const Statistic value)
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 268 of file CloudWatchAlarmDefinition.h.

◆ WithStatistic() [2/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithStatistic ( Statistic &&  value)
inline

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Definition at line 274 of file CloudWatchAlarmDefinition.h.

◆ WithThreshold()

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithThreshold ( double  value)
inline

The value against which the specified statistic is compared.

Definition at line 295 of file CloudWatchAlarmDefinition.h.

◆ WithUnit() [1/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithUnit ( const Unit value)
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 331 of file CloudWatchAlarmDefinition.h.

◆ WithUnit() [2/2]

CloudWatchAlarmDefinition& Aws::EMR::Model::CloudWatchAlarmDefinition::WithUnit ( Unit &&  value)
inline

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Definition at line 338 of file CloudWatchAlarmDefinition.h.


The documentation for this class was generated from the following file: