Interface LogAlarm.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LogAlarm.Builder,LogAlarm>, SdkBuilder<LogAlarm.Builder,LogAlarm>, SdkPojo
Enclosing class:
LogAlarm
@Mutable @NotThreadSafe public static interface LogAlarm.Builder extends SdkPojo, CopyableBuilder<LogAlarm.Builder,LogAlarm>

  • Method Details

    • alarmName

      LogAlarm.Builder alarmName(String alarmName)

      The name of the alarm.

      Parameters:
      alarmName - The name of the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmArn

      LogAlarm.Builder alarmArn(String alarmArn)

      The Amazon Resource Name (ARN) of the alarm.

      Parameters:
      alarmArn - The Amazon Resource Name (ARN) of the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmDescription

      LogAlarm.Builder alarmDescription(String alarmDescription)

      The description of the alarm.

      Parameters:
      alarmDescription - The description of the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmConfigurationUpdatedTimestamp

      LogAlarm.Builder alarmConfigurationUpdatedTimestamp(Instant alarmConfigurationUpdatedTimestamp)

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

      Parameters:
      alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionsEnabled

      LogAlarm.Builder actionsEnabled(Boolean actionsEnabled)

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

      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • okActions

      LogAlarm.Builder okActions(Collection<String> okActions)

      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).

      Parameters:
      okActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • okActions

      LogAlarm.Builder okActions(String... okActions)

      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).

      Parameters:
      okActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmActions

      LogAlarm.Builder alarmActions(Collection<String> alarmActions)

      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).

      Parameters:
      alarmActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmActions

      LogAlarm.Builder alarmActions(String... alarmActions)

      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).

      Parameters:
      alarmActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • insufficientDataActions

      LogAlarm.Builder insufficientDataActions(Collection<String> insufficientDataActions)

      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).

      Parameters:
      insufficientDataActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • insufficientDataActions

      LogAlarm.Builder insufficientDataActions(String... insufficientDataActions)

      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).

      Parameters:
      insufficientDataActions - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateValue

      LogAlarm.Builder stateValue(String stateValue)

      The state value for the alarm.

      Parameters:
      stateValue - The state value for the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateValue

      LogAlarm.Builder stateValue(StateValue stateValue)

      The state value for the alarm.

      Parameters:
      stateValue - The state value for the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateReason

      LogAlarm.Builder stateReason(String stateReason)

      An explanation for the alarm state, in text format.

      Parameters:
      stateReason - An explanation for the alarm state, in text format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateReasonData

      LogAlarm.Builder stateReasonData(String stateReasonData)

      An explanation for the alarm state, in JSON format.

      Parameters:
      stateReasonData - An explanation for the alarm state, in JSON format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateUpdatedTimestamp

      LogAlarm.Builder stateUpdatedTimestamp(Instant stateUpdatedTimestamp)

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

      Parameters:
      stateUpdatedTimestamp - The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledQueryConfiguration

      LogAlarm.Builder scheduledQueryConfiguration(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledQueryConfiguration

      default LogAlarm.Builder scheduledQueryConfiguration(Consumer<ScheduledQueryConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the ScheduledQueryConfiguration.Builder avoiding the need to create one manually via ScheduledQueryConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scheduledQueryConfiguration(ScheduledQueryConfiguration).

      Parameters:
      scheduledQueryConfiguration - a consumer that will call methods on ScheduledQueryConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryResultsToEvaluate

      LogAlarm.Builder queryResultsToEvaluate(Integer queryResultsToEvaluate)

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

      Parameters:
      queryResultsToEvaluate - The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryResultsToAlarm

      LogAlarm.Builder queryResultsToAlarm(Integer queryResultsToAlarm)

      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).

      Parameters:
      queryResultsToAlarm - 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).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threshold

      LogAlarm.Builder threshold(Double threshold)

      The value to compare with the aggregated query result.

      Parameters:
      threshold - The value to compare with the aggregated query result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • comparisonOperator

      LogAlarm.Builder comparisonOperator(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comparisonOperator

      LogAlarm.Builder comparisonOperator(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • treatMissingData

      LogAlarm.Builder treatMissingData(String treatMissingData)

      How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

      Parameters:
      treatMissingData - How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTransitionedTimestamp

      LogAlarm.Builder stateTransitionedTimestamp(Instant stateTransitionedTimestamp)

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

      Parameters:
      stateTransitionedTimestamp - The date and time that the alarm's StateValue most recently changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationState

      LogAlarm.Builder evaluationState(String 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.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      Parameters:
      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.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evaluationState

      LogAlarm.Builder evaluationState(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.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      Parameters:
      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.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionLogLineCount

      LogAlarm.Builder actionLogLineCount(Integer actionLogLineCount)

      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.

      Parameters:
      actionLogLineCount - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionLogLineRoleArn

      LogAlarm.Builder actionLogLineRoleArn(String actionLogLineRoleArn)

      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.

      Parameters:
      actionLogLineRoleArn - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.