Class PutLogAlarmRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
software.amazon.awssdk.services.cloudwatch.model.PutLogAlarmRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutLogAlarmRequest.Builder,PutLogAlarmRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutLogAlarmRequest extends CloudWatchRequest implements ToCopyableBuilder<PutLogAlarmRequest.Builder,PutLogAlarmRequest>

  • Method Details

    • alarmName

      public final String alarmName()

      The name for the alarm. This name must be unique within the Amazon Web Services account and Region.

      Returns:
      The name for the alarm. This name must be unique within the Amazon Web Services account and Region.

    • alarmDescription

      public final String alarmDescription()

      The description for the alarm.

      Returns:
      The description for the alarm.

    • scheduledQueryConfiguration

      public final ScheduledQueryConfiguration scheduledQueryConfiguration()

      The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.

      Returns:
      The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.

    • actionLogLineCount

      public final Integer actionLogLineCount()

      The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.

      Returns:
      The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.

    • actionLogLineRoleArn

      public final String actionLogLineRoleArn()

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

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

    • actionsEnabled

      public final Boolean actionsEnabled()

      Indicates whether actions should be executed during any changes to the alarm state. The default is true.

      Returns:
      Indicates whether actions should be executed during any changes to the alarm state. The default is true.

    • hasOkActions

      public final boolean hasOkActions()
      For responses, this returns true if the service returned a value for the OKActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • okActions

      public final List<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).

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOkActions() method.

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

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    • hasAlarmActions

      public final boolean hasAlarmActions()
      For responses, this returns true if the service returned a value for the AlarmActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • alarmActions

      public final List<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).

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      Systems Manager actions:

      arn:aws:ssm:region:account-id:opsitem:severity

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarmActions() method.

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

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      Systems Manager actions:

      arn:aws:ssm:region:account-id:opsitem:severity

    • hasInsufficientDataActions

      public final boolean hasInsufficientDataActions()
      For responses, this returns true if the service returned a value for the InsufficientDataActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • insufficientDataActions

      public final List<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).

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsufficientDataActions() method.

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

      Valid Values:

      Amazon SNS actions:

      arn:aws:sns:region:account-id:sns-topic-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

    • queryResultsToEvaluate

      public final Integer queryResultsToEvaluate()

      The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.

      Returns:
      The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.

    • queryResultsToAlarm

      public final 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). Must be less than or equal to QueryResultsToEvaluate.

      Returns:
      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). Must be less than or equal to QueryResultsToEvaluate.

    • threshold

      public final Double threshold()

      The value to compare with the aggregated query result.

      Returns:
      The value to compare with the aggregated query result.

    • comparisonOperator

      public final 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. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
      See Also:

    • treatMissingData

      public final String treatMissingData()

      Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. If this parameter is omitted, the default behavior of missing is used.

      Returns:
      Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. If this parameter is omitted, the default behavior of missing is used.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.

    • toBuilder

      public PutLogAlarmRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutLogAlarmRequest.Builder,PutLogAlarmRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static PutLogAlarmRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutLogAlarmRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.