Package software.amazon.awssdk.services.cloudwatch.model

Class PutAlarmMuteRuleRequest

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.PutAlarmMuteRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutAlarmMuteRuleRequest extends CloudWatchRequest implements ToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>

  • Method Details

    • name

      public final String name()

      The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.

      Returns:
      The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.

    • description

      public final String description()

      A description of the alarm mute rule that helps you identify its purpose.

      Returns:
      A description of the alarm mute rule that helps you identify its purpose.

    • rule

      public final Rule rule()

      The configuration that defines when and how long alarms should be muted.

      Returns:
      The configuration that defines when and how long alarms should be muted.

    • muteTargets

      public final MuteTargets muteTargets()

      Specifies which alarms this rule applies to.

      Returns:
      Specifies which alarms this rule applies to.

    • 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 mute rule. You can use tags to categorize and manage your mute rules.

      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 mute rule. You can use tags to categorize and manage your mute rules.

    • startDate

      public final Instant startDate()

      The date and time after which the mute rule takes effect, specified as a timestamp in ISO 8601 format (for example, 2026-04-15T08:00:00Z). If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.

      Returns:
      The date and time after which the mute rule takes effect, specified as a timestamp in ISO 8601 format (for example, 2026-04-15T08:00:00Z). If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.

    • expireDate

      public final Instant expireDate()

      The date and time when the mute rule expires and is no longer evaluated, specified as a timestamp in ISO 8601 format (for example, 2026-12-31T23:59:59Z). After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.

      Returns:
      The date and time when the mute rule expires and is no longer evaluated, specified as a timestamp in ISO 8601 format (for example, 2026-12-31T23:59:59Z). After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.

    • toBuilder

      public PutAlarmMuteRuleRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutAlarmMuteRuleRequest.Builder,PutAlarmMuteRuleRequest>
      Specified by:
      toBuilder in class CloudWatchRequest

    • builder

      public static PutAlarmMuteRuleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutAlarmMuteRuleRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo