software.amazon.awscdk.services.cloudwatch

Interface IAlarm.Jsii$Default

All Superinterfaces:

IAlarm, IAlarmRule, IAlarmRule.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IAlarm.Jsii$Proxy

Enclosing interface:

IAlarm

@Internal
public static interface IAlarm.Jsii$Default
extends IAlarm, IResource.Jsii$Default, IAlarmRule.Jsii$Default

Internal default implementation for IAlarm.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IAlarm

IAlarm.Jsii$Default, IAlarm.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getAlarmArn() Alarm ARN (i.e.
default String	getAlarmName() Name of the alarm.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default String	renderAlarmRule() serialized representation of Alarm Rule to be used when building the Composite Alarm resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getAlarmArn

@Stability(value=Stable)
 @NotNull
default String getAlarmArn()

Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo).

Specified by:

getAlarmArn in interface IAlarm

getAlarmName

@Stability(value=Stable)
 @NotNull
default String getAlarmName()

Name of the alarm.

Specified by:

getAlarmName in interface IAlarm

renderAlarmRule

@Stability(value=Stable)
 @NotNull
default String renderAlarmRule()

serialized representation of Alarm Rule to be used when building the Composite Alarm resource.

Specified by:

renderAlarmRule in interface IAlarmRule

Specified by:

renderAlarmRule in interface IAlarmRule.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

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

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.