Class AlarmMuteRule


  • public class AlarmMuteRule
    extends com.pulumi.resources.CustomResource
    Manages an AWS CloudWatch Alarm Mute Rule. ## Example Usage ### Basic Usage with Cron Expression
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.AlarmMuteRule;
     import com.pulumi.aws.cloudwatch.AlarmMuteRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleScheduleArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new AlarmMuteRule("example", AlarmMuteRuleArgs.builder()
                 .rule(AlarmMuteRuleRuleArgs.builder()
                     .schedule(AlarmMuteRuleRuleScheduleArgs.builder()
                         .duration("PT4H")
                         .expression("cron(0 2 * * *)")
                         .build())
                     .build())
                 .name("example")
                 .build());
     
         }
     }
     
     
    ### With Start/Expire Dates Option
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.MetricAlarm;
     import com.pulumi.aws.cloudwatch.MetricAlarmArgs;
     import com.pulumi.aws.cloudwatch.AlarmMuteRule;
     import com.pulumi.aws.cloudwatch.AlarmMuteRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleScheduleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleMuteTargetsArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new MetricAlarm("example", MetricAlarmArgs.builder()
                 .name("example")
                 .comparisonOperator("GreaterThanThreshold")
                 .evaluationPeriods(2)
                 .metricName("CPUUtilization")
                 .namespace("AWS/EC2")
                 .period(120)
                 .statistic("Average")
                 .threshold(80.0)
                 .build());
     
             var exampleAlarmMuteRule = new AlarmMuteRule("exampleAlarmMuteRule", AlarmMuteRuleArgs.builder()
                 .rule(AlarmMuteRuleRuleArgs.builder()
                     .schedule(AlarmMuteRuleRuleScheduleArgs.builder()
                         .duration("PT4H")
                         .expression("cron(0 2 * * *)")
                         .timezone("Asia/Tokyo")
                         .build())
                     .build())
                 .muteTargets(AlarmMuteRuleMuteTargetsArgs.builder()
                     .alarmNames(example.name())
                     .build())
                 .name("example")
                 .description("Mute alarms during maintenance window")
                 .startDate("2026-01-01T00:00:00Z")
                 .expireDate("2026-12-31T23:59:00Z")
                 .tags(Map.of("Environment", "production"))
                 .build());
     
         }
     }
     
     
    ### With At Expression > **NOTE:** When using `at()` expressions, do not set `startDate` or `expireDate`. The CloudWatch API returns the error `Can not set start or expire dates for At expressions`.
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.AlarmMuteRule;
     import com.pulumi.aws.cloudwatch.AlarmMuteRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleArgs;
     import com.pulumi.aws.cloudwatch.inputs.AlarmMuteRuleRuleScheduleArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new AlarmMuteRule("example", AlarmMuteRuleArgs.builder()
                 .rule(AlarmMuteRuleRuleArgs.builder()
                     .schedule(AlarmMuteRuleRuleScheduleArgs.builder()
                         .duration("PT4H")
                         .expression("at(2026-12-31T23:59:59)")
                         .build())
                     .build())
                 .name("example")
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `name` (String) Name of the CloudWatch Alarm Mute Rule. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import CloudWatch Alarm Mute Rule using the `name`. For example: ```sh $ pulumi import aws:cloudwatch/alarmMuteRule:AlarmMuteRule example example ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> expireDate()  
      static AlarmMuteRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AlarmMuteRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastUpdatedTimestamp()  
      com.pulumi.core.Output<java.util.Optional<AlarmMuteRuleMuteTargets>> muteTargets()  
      com.pulumi.core.Output<java.lang.String> muteType()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<AlarmMuteRuleRule>> rule()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> startDate()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AlarmMuteRule

        public AlarmMuteRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • AlarmMuteRule

        public AlarmMuteRule​(java.lang.String name,
                             @Nullable
                             AlarmMuteRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • AlarmMuteRule

        public AlarmMuteRule​(java.lang.String name,
                             @Nullable
                             AlarmMuteRuleArgs args,
                             @Nullable
                             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Alarm Mute Rule.
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the alarm mute rule.
      • expireDate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> expireDate()
        Returns:
        Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) when the mute rule expires. Seconds must be set to `00` (e.g., `2026-12-31T23:59:00Z`). Must not be set when using `at()` expressions.
      • lastUpdatedTimestamp

        public com.pulumi.core.Output<java.lang.String> lastUpdatedTimestamp()
        Returns:
        Timestamp of when the mute rule was last updated.
      • muteTargets

        public com.pulumi.core.Output<java.util.Optional<AlarmMuteRuleMuteTargets>> muteTargets()
        Returns:
        Alarms to mute. See `muteTargets` block below for details.
      • muteType

        public com.pulumi.core.Output<java.lang.String> muteType()
        Returns:
        Indicates whether the mute rule is one-time or recurring. Valid values are `ONE_TIME` or `RECURRING`. See [Alarm mute rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-mute-rules.html) for details.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the alarm mute rule. Changing this forces a new resource.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • rule

        public com.pulumi.core.Output<java.util.Optional<AlarmMuteRuleRule>> rule()
        Returns:
        Rule definition for the mute rule. See `rule` block below for details. The following arguments are optional:
      • startDate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> startDate()
        Returns:
        Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) when the mute rule becomes active. Seconds must be set to `00` (e.g., `2026-01-01T00:00:00Z`). Must not be set when using `at()` expressions.
      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current status of the mute rule. Valid values are `SCHEDULED`, `ACTIVE`, or `EXPIRED`.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • get

        public static AlarmMuteRule get​(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        AlarmMuteRuleState state,
                                        @Nullable
                                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.