cloudwatch/aws.sdk.kotlin.services.cloudwatch.model/LogAlarm/Builder

Builder

Properties

The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

actionLogLineRoleArn

var actionLogLineRoleArn: String?

The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

actionsEnabled

var actionsEnabled: Boolean?

Indicates whether actions should be executed during any changes to the alarm state.

alarmActions

var alarmActions: List<String>?

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

alarmArn

var alarmArn: String?

The Amazon Resource Name (ARN) of the alarm.

alarmConfigurationUpdatedTimestamp

var alarmConfigurationUpdatedTimestamp: Instant?

The time stamp of the last update to the alarm configuration.

alarmDescription

var alarmDescription: String?

The description of the alarm.

alarmName

var alarmName: String?

The name of the alarm.

comparisonOperator

var comparisonOperator: ComparisonOperator?

The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

evaluationState

var evaluationState: EvaluationState?

If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

insufficientDataActions

var insufficientDataActions: List<String>?

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

okActions

var okActions: List<String>?

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

queryResultsToAlarm

var queryResultsToAlarm: Int?

The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

queryResultsToEvaluate

var queryResultsToEvaluate: Int?

The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

scheduledQueryConfiguration

var scheduledQueryConfiguration: ScheduledQueryConfiguration?

The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

stateReason

var stateReason: String?

An explanation for the alarm state, in text format.

stateReasonData

var stateReasonData: String?

An explanation for the alarm state, in JSON format.

stateTransitionedTimestamp

var stateTransitionedTimestamp: Instant?

The date and time that the alarm's StateValue most recently changed.

stateUpdatedTimestamp

var stateUpdatedTimestamp: Instant?

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.