published on Thursday, Apr 30, 2026 by Pulumi
published on Thursday, Apr 30, 2026 by Pulumi
Manages an AWS CloudWatch Alarm Mute Rule.
Example Usage
Basic Usage with Cron Expression
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cloudwatch.AlarmMuteRule("example", {
name: "example",
rule: {
schedule: {
duration: "PT4H",
expression: "cron(0 2 * * *)",
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.cloudwatch.AlarmMuteRule("example",
name="example",
rule={
"schedule": {
"duration": "PT4H",
"expression": "cron(0 2 * * *)",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewAlarmMuteRule(ctx, "example", &cloudwatch.AlarmMuteRuleArgs{
Name: pulumi.String("example"),
Rule: &cloudwatch.AlarmMuteRuleRuleArgs{
Schedule: &cloudwatch.AlarmMuteRuleRuleScheduleArgs{
Duration: pulumi.String("PT4H"),
Expression: pulumi.String("cron(0 2 * * *)"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.CloudWatch.AlarmMuteRule("example", new()
{
Name = "example",
Rule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleArgs
{
Schedule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleScheduleArgs
{
Duration = "PT4H",
Expression = "cron(0 2 * * *)",
},
},
});
});
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.List;
import java.util.ArrayList;
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()
.name("example")
.rule(AlarmMuteRuleRuleArgs.builder()
.schedule(AlarmMuteRuleRuleScheduleArgs.builder()
.duration("PT4H")
.expression("cron(0 2 * * *)")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:cloudwatch:AlarmMuteRule
properties:
name: example
rule:
schedule:
duration: PT4H
expression: cron(0 2 * * *)
With Start/Expire Dates Option
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.index.CloudwatchAlarm("example", {
alarmName: "example",
comparisonOperator: "GreaterThanThreshold",
evaluationPeriods: 2,
metricName: "CPUUtilization",
namespace: "AWS/EC2",
period: 120,
statistic: "Average",
threshold: 80,
});
const exampleAlarmMuteRule = new aws.cloudwatch.AlarmMuteRule("example", {
name: "example",
description: "Mute alarms during maintenance window",
startDate: "2026-01-01T00:00:00Z",
expireDate: "2026-12-31T23:59:00Z",
rule: {
schedule: {
duration: "PT4H",
expression: "cron(0 2 * * *)",
timezone: "Asia/Tokyo",
},
},
muteTargets: {
alarmNames: [example.alarmName],
},
tags: {
Environment: "production",
},
});
import pulumi
import pulumi_aws as aws
example = aws.CloudwatchAlarm("example",
alarm_name=example,
comparison_operator=GreaterThanThreshold,
evaluation_periods=2,
metric_name=CPUUtilization,
namespace=AWS/EC2,
period=120,
statistic=Average,
threshold=80)
example_alarm_mute_rule = aws.cloudwatch.AlarmMuteRule("example",
name="example",
description="Mute alarms during maintenance window",
start_date="2026-01-01T00:00:00Z",
expire_date="2026-12-31T23:59:00Z",
rule={
"schedule": {
"duration": "PT4H",
"expression": "cron(0 2 * * *)",
"timezone": "Asia/Tokyo",
},
},
mute_targets={
"alarm_names": [example["alarmName"]],
},
tags={
"Environment": "production",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := aws.NewCloudwatchAlarm(ctx, "example", &aws.CloudwatchAlarmArgs{
AlarmName: "example",
ComparisonOperator: "GreaterThanThreshold",
EvaluationPeriods: 2,
MetricName: "CPUUtilization",
Namespace: "AWS/EC2",
Period: 120,
Statistic: "Average",
Threshold: 80,
})
if err != nil {
return err
}
_, err = cloudwatch.NewAlarmMuteRule(ctx, "example", &cloudwatch.AlarmMuteRuleArgs{
Name: pulumi.String("example"),
Description: pulumi.String("Mute alarms during maintenance window"),
StartDate: pulumi.String("2026-01-01T00:00:00Z"),
ExpireDate: pulumi.String("2026-12-31T23:59:00Z"),
Rule: &cloudwatch.AlarmMuteRuleRuleArgs{
Schedule: &cloudwatch.AlarmMuteRuleRuleScheduleArgs{
Duration: pulumi.String("PT4H"),
Expression: pulumi.String("cron(0 2 * * *)"),
Timezone: pulumi.String("Asia/Tokyo"),
},
},
MuteTargets: &cloudwatch.AlarmMuteRuleMuteTargetsArgs{
AlarmNames: pulumi.StringArray{
example.AlarmName,
},
},
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Index.CloudwatchAlarm("example", new()
{
AlarmName = "example",
ComparisonOperator = "GreaterThanThreshold",
EvaluationPeriods = 2,
MetricName = "CPUUtilization",
Namespace = "AWS/EC2",
Period = 120,
Statistic = "Average",
Threshold = 80,
});
var exampleAlarmMuteRule = new Aws.CloudWatch.AlarmMuteRule("example", new()
{
Name = "example",
Description = "Mute alarms during maintenance window",
StartDate = "2026-01-01T00:00:00Z",
ExpireDate = "2026-12-31T23:59:00Z",
Rule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleArgs
{
Schedule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleScheduleArgs
{
Duration = "PT4H",
Expression = "cron(0 2 * * *)",
Timezone = "Asia/Tokyo",
},
},
MuteTargets = new Aws.CloudWatch.Inputs.AlarmMuteRuleMuteTargetsArgs
{
AlarmNames = new[]
{
example.AlarmName,
},
},
Tags =
{
{ "Environment", "production" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.CloudwatchAlarm;
import com.pulumi.aws.CloudwatchAlarmArgs;
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.List;
import java.util.ArrayList;
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 CloudwatchAlarm("example", CloudwatchAlarmArgs.builder()
.alarmName("example")
.comparisonOperator("GreaterThanThreshold")
.evaluationPeriods(2)
.metricName("CPUUtilization")
.namespace("AWS/EC2")
.period(120)
.statistic("Average")
.threshold(80)
.build());
var exampleAlarmMuteRule = new AlarmMuteRule("exampleAlarmMuteRule", AlarmMuteRuleArgs.builder()
.name("example")
.description("Mute alarms during maintenance window")
.startDate("2026-01-01T00:00:00Z")
.expireDate("2026-12-31T23:59:00Z")
.rule(AlarmMuteRuleRuleArgs.builder()
.schedule(AlarmMuteRuleRuleScheduleArgs.builder()
.duration("PT4H")
.expression("cron(0 2 * * *)")
.timezone("Asia/Tokyo")
.build())
.build())
.muteTargets(AlarmMuteRuleMuteTargetsArgs.builder()
.alarmNames(example.alarmName())
.build())
.tags(Map.of("Environment", "production"))
.build());
}
}
resources:
example:
type: aws:CloudwatchAlarm
properties:
alarmName: example
comparisonOperator: GreaterThanThreshold
evaluationPeriods: 2
metricName: CPUUtilization
namespace: AWS/EC2
period: 120
statistic: Average
threshold: 80
exampleAlarmMuteRule:
type: aws:cloudwatch:AlarmMuteRule
name: example
properties:
name: example
description: Mute alarms during maintenance window
startDate: 2026-01-01T00:00:00Z
expireDate: 2026-12-31T23:59:00Z
rule:
schedule:
duration: PT4H
expression: cron(0 2 * * *)
timezone: Asia/Tokyo
muteTargets:
alarmNames:
- ${example.alarmName}
tags:
Environment: production
With At Expression
NOTE: When using
at()expressions, do not setstartDateorexpireDate. The CloudWatch API returns the errorCan not set start or expire dates for At expressions.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.cloudwatch.AlarmMuteRule("example", {
name: "example",
rule: {
schedule: {
duration: "PT4H",
expression: "at(2026-12-31T23:59:59)",
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.cloudwatch.AlarmMuteRule("example",
name="example",
rule={
"schedule": {
"duration": "PT4H",
"expression": "at(2026-12-31T23:59:59)",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewAlarmMuteRule(ctx, "example", &cloudwatch.AlarmMuteRuleArgs{
Name: pulumi.String("example"),
Rule: &cloudwatch.AlarmMuteRuleRuleArgs{
Schedule: &cloudwatch.AlarmMuteRuleRuleScheduleArgs{
Duration: pulumi.String("PT4H"),
Expression: pulumi.String("at(2026-12-31T23:59:59)"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.CloudWatch.AlarmMuteRule("example", new()
{
Name = "example",
Rule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleArgs
{
Schedule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleScheduleArgs
{
Duration = "PT4H",
Expression = "at(2026-12-31T23:59:59)",
},
},
});
});
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.List;
import java.util.ArrayList;
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()
.name("example")
.rule(AlarmMuteRuleRuleArgs.builder()
.schedule(AlarmMuteRuleRuleScheduleArgs.builder()
.duration("PT4H")
.expression("at(2026-12-31T23:59:59)")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:cloudwatch:AlarmMuteRule
properties:
name: example
rule:
schedule:
duration: PT4H
expression: at(2026-12-31T23:59:59)
Create AlarmMuteRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AlarmMuteRule(name: string, args?: AlarmMuteRuleArgs, opts?: CustomResourceOptions);@overload
def AlarmMuteRule(resource_name: str,
args: Optional[AlarmMuteRuleArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AlarmMuteRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
expire_date: Optional[str] = None,
mute_targets: Optional[AlarmMuteRuleMuteTargetsArgs] = None,
name: Optional[str] = None,
region: Optional[str] = None,
rule: Optional[AlarmMuteRuleRuleArgs] = None,
start_date: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewAlarmMuteRule(ctx *Context, name string, args *AlarmMuteRuleArgs, opts ...ResourceOption) (*AlarmMuteRule, error)public AlarmMuteRule(string name, AlarmMuteRuleArgs? args = null, CustomResourceOptions? opts = null)
public AlarmMuteRule(String name, AlarmMuteRuleArgs args)
public AlarmMuteRule(String name, AlarmMuteRuleArgs args, CustomResourceOptions options)
type: aws:cloudwatch:AlarmMuteRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AlarmMuteRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AlarmMuteRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AlarmMuteRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AlarmMuteRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AlarmMuteRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var alarmMuteRuleResource = new Aws.CloudWatch.AlarmMuteRule("alarmMuteRuleResource", new()
{
Description = "string",
ExpireDate = "string",
MuteTargets = new Aws.CloudWatch.Inputs.AlarmMuteRuleMuteTargetsArgs
{
AlarmNames = new[]
{
"string",
},
},
Name = "string",
Region = "string",
Rule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleArgs
{
Schedule = new Aws.CloudWatch.Inputs.AlarmMuteRuleRuleScheduleArgs
{
Duration = "string",
Expression = "string",
Timezone = "string",
},
},
StartDate = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := cloudwatch.NewAlarmMuteRule(ctx, "alarmMuteRuleResource", &cloudwatch.AlarmMuteRuleArgs{
Description: pulumi.String("string"),
ExpireDate: pulumi.String("string"),
MuteTargets: &cloudwatch.AlarmMuteRuleMuteTargetsArgs{
AlarmNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
Rule: &cloudwatch.AlarmMuteRuleRuleArgs{
Schedule: &cloudwatch.AlarmMuteRuleRuleScheduleArgs{
Duration: pulumi.String("string"),
Expression: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
},
StartDate: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var alarmMuteRuleResource = new AlarmMuteRule("alarmMuteRuleResource", AlarmMuteRuleArgs.builder()
.description("string")
.expireDate("string")
.muteTargets(AlarmMuteRuleMuteTargetsArgs.builder()
.alarmNames("string")
.build())
.name("string")
.region("string")
.rule(AlarmMuteRuleRuleArgs.builder()
.schedule(AlarmMuteRuleRuleScheduleArgs.builder()
.duration("string")
.expression("string")
.timezone("string")
.build())
.build())
.startDate("string")
.tags(Map.of("string", "string"))
.build());
alarm_mute_rule_resource = aws.cloudwatch.AlarmMuteRule("alarmMuteRuleResource",
description="string",
expire_date="string",
mute_targets={
"alarm_names": ["string"],
},
name="string",
region="string",
rule={
"schedule": {
"duration": "string",
"expression": "string",
"timezone": "string",
},
},
start_date="string",
tags={
"string": "string",
})
const alarmMuteRuleResource = new aws.cloudwatch.AlarmMuteRule("alarmMuteRuleResource", {
description: "string",
expireDate: "string",
muteTargets: {
alarmNames: ["string"],
},
name: "string",
region: "string",
rule: {
schedule: {
duration: "string",
expression: "string",
timezone: "string",
},
},
startDate: "string",
tags: {
string: "string",
},
});
type: aws:cloudwatch:AlarmMuteRule
properties:
description: string
expireDate: string
muteTargets:
alarmNames:
- string
name: string
region: string
rule:
schedule:
duration: string
expression: string
timezone: string
startDate: string
tags:
string: string
AlarmMuteRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AlarmMuteRule resource accepts the following input properties:
- Description string
- Description of the alarm mute rule.
- Expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - Mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - Name string
- Name of the alarm mute rule. Changing this forces a new resource.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- Start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Description string
- Description of the alarm mute rule.
- Expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - Mute
Targets AlarmMute Rule Mute Targets Args - Alarms to mute. See
muteTargetsblock below for details. - Name string
- Name of the alarm mute rule. Changing this forces a new resource.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Rule
Alarm
Mute Rule Rule Args Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- Start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- description String
- Description of the alarm mute rule.
- expire
Date String - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - name String
- Name of the alarm mute rule. Changing this forces a new resource.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date String - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- description string
- Description of the alarm mute rule.
- expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - name string
- Name of the alarm mute rule. Changing this forces a new resource.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- description str
- Description of the alarm mute rule.
- expire_
date str - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - mute_
targets AlarmMute Rule Mute Targets Args - Alarms to mute. See
muteTargetsblock below for details. - name str
- Name of the alarm mute rule. Changing this forces a new resource.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Args Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start_
date str - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- description String
- Description of the alarm mute rule.
- expire
Date String - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - mute
Targets Property Map - Alarms to mute. See
muteTargetsblock below for details. - name String
- Name of the alarm mute rule. Changing this forces a new resource.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule Property Map
Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date String - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the AlarmMuteRule resource produces the following output properties:
- Arn string
- ARN of the Alarm Mute Rule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- Mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - Status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- Arn string
- ARN of the Alarm Mute Rule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- Mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - Status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the Alarm Mute Rule.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Type String - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - status String
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn string
- ARN of the Alarm Mute Rule.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn str
- ARN of the Alarm Mute Rule.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
updated_ strtimestamp - Timestamp of when the mute rule was last updated.
- mute_
type str - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - status str
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the Alarm Mute Rule.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Type String - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - status String
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
Look up Existing AlarmMuteRule Resource
Get an existing AlarmMuteRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AlarmMuteRuleState, opts?: CustomResourceOptions): AlarmMuteRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
description: Optional[str] = None,
expire_date: Optional[str] = None,
last_updated_timestamp: Optional[str] = None,
mute_targets: Optional[AlarmMuteRuleMuteTargetsArgs] = None,
mute_type: Optional[str] = None,
name: Optional[str] = None,
region: Optional[str] = None,
rule: Optional[AlarmMuteRuleRuleArgs] = None,
start_date: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> AlarmMuteRulefunc GetAlarmMuteRule(ctx *Context, name string, id IDInput, state *AlarmMuteRuleState, opts ...ResourceOption) (*AlarmMuteRule, error)public static AlarmMuteRule Get(string name, Input<string> id, AlarmMuteRuleState? state, CustomResourceOptions? opts = null)public static AlarmMuteRule get(String name, Output<String> id, AlarmMuteRuleState state, CustomResourceOptions options)resources: _: type: aws:cloudwatch:AlarmMuteRule get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the Alarm Mute Rule.
- Description string
- Description of the alarm mute rule.
- Expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - Last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- Mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - Mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - Name string
- Name of the alarm mute rule. Changing this forces a new resource.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- Start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- Arn string
- ARN of the Alarm Mute Rule.
- Description string
- Description of the alarm mute rule.
- Expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - Last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- Mute
Targets AlarmMute Rule Mute Targets Args - Alarms to mute. See
muteTargetsblock below for details. - Mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - Name string
- Name of the alarm mute rule. Changing this forces a new resource.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Rule
Alarm
Mute Rule Rule Args Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- Start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - Status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - map[string]string
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the Alarm Mute Rule.
- description String
- Description of the alarm mute rule.
- expire
Date String - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - last
Updated StringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - mute
Type String - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - name String
- Name of the alarm mute rule. Changing this forces a new resource.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date String - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - status String
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn string
- ARN of the Alarm Mute Rule.
- description string
- Description of the alarm mute rule.
- expire
Date string - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - last
Updated stringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Targets AlarmMute Rule Mute Targets - Alarms to mute. See
muteTargetsblock below for details. - mute
Type string - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - name string
- Name of the alarm mute rule. Changing this forces a new resource.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date string - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - status string
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn str
- ARN of the Alarm Mute Rule.
- description str
- Description of the alarm mute rule.
- expire_
date str - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - last_
updated_ strtimestamp - Timestamp of when the mute rule was last updated.
- mute_
targets AlarmMute Rule Mute Targets Args - Alarms to mute. See
muteTargetsblock below for details. - mute_
type str - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - name str
- Name of the alarm mute rule. Changing this forces a new resource.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule
Alarm
Mute Rule Rule Args Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start_
date str - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - status str
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the Alarm Mute Rule.
- description String
- Description of the alarm mute rule.
- expire
Date String - Date and time in RFC3339 format when the mute rule expires. Seconds must be set to
00(e.g.,2026-12-31T23:59:00Z). Must not be set when usingat()expressions. - last
Updated StringTimestamp - Timestamp of when the mute rule was last updated.
- mute
Targets Property Map - Alarms to mute. See
muteTargetsblock below for details. - mute
Type String - Indicates whether the mute rule is one-time or recurring. Valid values are
ONE_TIMEorRECURRING. See Alarm mute rules for details. - name String
- Name of the alarm mute rule. Changing this forces a new resource.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- rule Property Map
Rule definition for the mute rule. See
ruleblock below for details.The following arguments are optional:
- start
Date String - Date and time in RFC3339 format when the mute rule becomes active. Seconds must be set to
00(e.g.,2026-01-01T00:00:00Z). Must not be set when usingat()expressions. - status String
- Current status of the mute rule. Valid values are
SCHEDULED,ACTIVE, orEXPIRED. - Map<String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
Supporting Types
AlarmMuteRuleMuteTargets, AlarmMuteRuleMuteTargetsArgs
- Alarm
Names List<string> - List of alarm names to mute.
- Alarm
Names []string - List of alarm names to mute.
- alarm
Names List<String> - List of alarm names to mute.
- alarm
Names string[] - List of alarm names to mute.
- alarm_
names Sequence[str] - List of alarm names to mute.
- alarm
Names List<String> - List of alarm names to mute.
AlarmMuteRuleRule, AlarmMuteRuleRuleArgs
- Schedule
Alarm
Mute Rule Rule Schedule - Schedule for the mute rule. See
scheduleblock below for details.
- Schedule
Alarm
Mute Rule Rule Schedule - Schedule for the mute rule. See
scheduleblock below for details.
- schedule
Alarm
Mute Rule Rule Schedule - Schedule for the mute rule. See
scheduleblock below for details.
- schedule
Alarm
Mute Rule Rule Schedule - Schedule for the mute rule. See
scheduleblock below for details.
- schedule
Alarm
Mute Rule Rule Schedule - Schedule for the mute rule. See
scheduleblock below for details.
- schedule Property Map
- Schedule for the mute rule. See
scheduleblock below for details.
AlarmMuteRuleRuleSchedule, AlarmMuteRuleRuleScheduleArgs
- Duration string
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - Expression string
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - Timezone string
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
- Duration string
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - Expression string
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - Timezone string
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
- duration String
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - expression String
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - timezone String
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
- duration string
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - expression string
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - timezone string
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
- duration str
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - expression str
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - timezone str
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
- duration String
- Duration of the mute period in ISO 8601 duration format (e.g.,
PT4Hfor 4 hours). - expression String
- Schedule expression. Supports
cron()andat()formats. For example,cron(0 2 * * *)for daily at 2:00 AM orat(2026-01-01T00:00)for a one-time mute. See Defining alarm mute rules for details. - timezone String
- Timezone for the schedule expression (e.g.,
Asia/Tokyo). Defaults to UTC.
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:
$ pulumi import aws:cloudwatch/alarmMuteRule:AlarmMuteRule example example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
published on Thursday, Apr 30, 2026 by Pulumi
