AlarmMuteRule L2 construct
A CloudWatch Alarm Mute Rule.
Example
declare const alarm1: cloudwatch.Alarm;
declare const alarm2: cloudwatch.Alarm;
const alarmMuteRule = new cloudwatch.AlarmMuteRule(this, 'AlarmMuteRule', {
alarms: [alarm1],
// Defines the mute period begins at 0:00 everyday in UTC
schedule: cloudwatch.ScheduleExpression.cron({ minute: '0', hour: '0' }),
// Specifies the mute rule lasts 1 hour.
duration: Duration.hours(1),
})
// The mute target can be added after construction.
alarmMuteRule.addAlarm(alarm2);
# alarm1: cloudwatch.Alarm
# alarm2: cloudwatch.Alarm
alarm_mute_rule = cloudwatch.AlarmMuteRule(self, "AlarmMuteRule",
alarms=[alarm1],
# Defines the mute period begins at 0:00 everyday in UTC
schedule=cloudwatch.ScheduleExpression.cron(minute="0", hour="0"),
# Specifies the mute rule lasts 1 hour.
duration=Duration.hours(1)
)
# The mute target can be added after construction.
alarm_mute_rule.add_alarm(alarm2)
Alarm alarm1;
Alarm alarm2;
AlarmMuteRule alarmMuteRule = AlarmMuteRule.Builder.create(this, "AlarmMuteRule")
.alarms(List.of(alarm1))
// Defines the mute period begins at 0:00 everyday in UTC
.schedule(ScheduleExpression.cron(CronOptions.builder().minute("0").hour("0").build()))
// Specifies the mute rule lasts 1 hour.
.duration(Duration.hours(1))
.build();
// The mute target can be added after construction.
alarmMuteRule.addAlarm(alarm2);
// Install: dotnet add package Amazon.CDK.Lib
Alarm alarm1;
Alarm alarm2;
var alarmMuteRule = new AlarmMuteRule(this, "AlarmMuteRule", new AlarmMuteRuleProps {
Alarms = new [] { alarm1 },
// Defines the mute period begins at 0:00 everyday in UTC
Schedule = ScheduleExpression.Cron(new CronOptions { Minute = "0", Hour = "0" }),
// Specifies the mute rule lasts 1 hour.
Duration = Duration.Hours(1)
});
// The mute target can be added after construction.
alarmMuteRule.AddAlarm(alarm2);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var alarm1 Alarm
var alarm2 Alarm
alarmMuteRule := cloudwatch.NewAlarmMuteRule(this, jsii.String("AlarmMuteRule"), &AlarmMuteRuleProps{
Alarms: []IAlarmRef{
alarm1,
},
// Defines the mute period begins at 0:00 everyday in UTC
Schedule: cloudwatch.ScheduleExpression_Cron(&CronOptions{
Minute: jsii.String("0"),
Hour: jsii.String("0"),
}),
// Specifies the mute rule lasts 1 hour.
Duration: awscdk.Duration_Hours(jsii.Number(1)),
})
// The mute target can be added after construction.
alarmMuteRule.AddAlarm(alarm2)
Initializer
new AlarmMuteRule(scope: Construct, id: string, props: AlarmMuteRuleProps)
AlarmMuteRule(scope: Construct, id: str, props: AlarmMuteRuleProps)
new AlarmMuteRule(Construct scope, String id, AlarmMuteRuleProps props)
new AlarmMuteRule(Construct scope, string id, AlarmMuteRuleProps props)
NewAlarmMuteRule(Scope Construct, Id *string, Props AlarmMuteRuleProps)
Construct Props
alarmMuteRuleNameoptionalstringalarm_mute_rule_nameoptionalstralarmMuteRuleNameoptionalStringAlarmMuteRuleNameoptionalstringAlarmMuteRuleNameoptional*string#Default: generated by CloudFormation
This name must be unique within your AWS account and region.
alarmsoptionalIAlarmRef[]alarmsoptionaltyping.List[IAlarmRef]alarmsoptionalList<IAlarmRef>AlarmsoptionalIAlarmRef[]Alarmsoptional*[]IAlarmRef#Default: no target alarms
You can specify up to 100 alarms.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: no description
Minimum: 1 minute, Maximum: 15 days
expireoptionalCalendarDateTimeexpireoptionalCalendarDateTimeexpireoptionalCalendarDateTimeExpireoptionalCalendarDateTimeExpireoptionalCalendarDateTime#Default: no configuration
After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.
This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
scheduleScheduleExpressionscheduleScheduleExpressionscheduleScheduleExpressionScheduleScheduleExpressionScheduleScheduleExpressionrequired#startoptionalCalendarDateTimestartoptionalCalendarDateTimestartoptionalCalendarDateTimeStartoptionalCalendarDateTimeStartoptionalCalendarDateTime#Default: no configuration
If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.
This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Default: No tags are applied
Tags help you organize and categorize your AWS resources.
Properties
alarmMuteRuleArnstringalarm_mute_rule_arnstralarmMuteRuleArnStringAlarmMuteRuleArnstringAlarmMuteRuleArn*string#alarmMuteRuleNamestringalarm_mute_rule_namestralarmMuteRuleNameStringAlarmMuteRuleNamestringAlarmMuteRuleName*string#alarmMuteRuleRefAlarmMuteRuleReferencealarm_mute_rule_refAlarmMuteRuleReferencealarmMuteRuleRefAlarmMuteRuleReferenceAlarmMuteRuleRefAlarmMuteRuleReferenceAlarmMuteRuleRefAlarmMuteRuleReference#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Methods
addAlarm(alarm: IAlarmRef): voiddef add_alarm(self, alarm: IAlarmRef) -> Nonepublic void addAlarm(IAlarmRef alarm)public void AddAlarm(IAlarmRef alarm)func AddAlarm(Alarm IAlarmRef)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromAlarmMuteRuleArn(scope: Construct, id: string, alarmMuteRuleArn: string): IAlarmMuteRule@staticmethod def from_alarm_mute_rule_arn(scope: Construct, id: str, alarm_mute_rule_arn: str) -> IAlarmMuteRulepublic static IAlarmMuteRule fromAlarmMuteRuleArn(Construct scope, String id, String alarmMuteRuleArn)public static IAlarmMuteRule FromAlarmMuteRuleArn(Construct scope, string id, string alarmMuteRuleArn)func FromAlarmMuteRuleArn(Scope Construct, Id *string, AlarmMuteRuleArn *string) IAlarmMuteRulestatic#3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.alarmMuteRuleArnalarm_mute_rule_arnalarmMuteRuleArnalarmMuteRuleArnAlarmMuteRuleArn— Alarm Mute Rule ARN.
fromAlarmMuteRuleName(scope: Construct, id: string, alarmMuteRuleName: string): IAlarmMuteRule@staticmethod def from_alarm_mute_rule_name(scope: Construct, id: str, alarm_mute_rule_name: str) -> IAlarmMuteRulepublic static IAlarmMuteRule fromAlarmMuteRuleName(Construct scope, String id, String alarmMuteRuleName)public static IAlarmMuteRule FromAlarmMuteRuleName(Construct scope, string id, string alarmMuteRuleName)func FromAlarmMuteRuleName(Scope Construct, Id *string, AlarmMuteRuleName *string) IAlarmMuteRulestatic#3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.alarmMuteRuleNamealarm_mute_rule_namealarmMuteRuleNamealarmMuteRuleNameAlarmMuteRuleName— Alarm Mute Rule Name.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.