Package software.amazon.awscdk.services.medialive

Class CfnCloudWatchAlarmTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.medialive.CfnCloudWatchAlarmTemplate
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:04.593Z") @Stability(Stable) public class CfnCloudWatchAlarmTemplate extends CfnResource implements IInspectable, ITaggableV2
Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 CfnCloudWatchAlarmTemplate cfnCloudWatchAlarmTemplate = CfnCloudWatchAlarmTemplate.Builder.create(this, "MyCfnCloudWatchAlarmTemplate")
         .comparisonOperator("comparisonOperator")
         .evaluationPeriods(123)
         .groupIdentifier("groupIdentifier")
         .metricName("metricName")
         .name("name")
         .period(123)
         .statistic("statistic")
         .targetResourceType("targetResourceType")
         .threshold(123)
         .treatMissingData("treatMissingData")
         // the properties below are optional
         .datapointsToAlarm(123)
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCloudWatchAlarmTemplate

      protected CfnCloudWatchAlarmTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCloudWatchAlarmTemplate

      protected CfnCloudWatchAlarmTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCloudWatchAlarmTemplate

      @Stability(Stable) public CfnCloudWatchAlarmTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCloudWatchAlarmTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      A cloudwatch alarm template's ARN (Amazon Resource Name).

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time of resource creation.

    • getAttrGroupId

      @Stability(Stable) @NotNull public String getAttrGroupId()
      A CloudWatch alarm template group's id.

      Amazon Web Services provided template groups have ids that start with aws-

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A cloudwatch alarm template's id.

      Amazon Web Services provided templates have ids that start with aws-.

    • getAttrIdentifier

      @Stability(Stable) @NotNull public String getAttrIdentifier()

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      The date and time of latest resource modification.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getComparisonOperator

      @Stability(Stable) @NotNull public String getComparisonOperator()
      The comparison operator used to compare the specified statistic and the threshold.

    • setComparisonOperator

      @Stability(Stable) public void setComparisonOperator(@NotNull String value)
      The comparison operator used to compare the specified statistic and the threshold.

    • getEvaluationPeriods

      @Stability(Stable) @NotNull public Number getEvaluationPeriods()
      The number of periods over which data is compared to the specified threshold.

    • setEvaluationPeriods

      @Stability(Stable) public void setEvaluationPeriods(@NotNull Number value)
      The number of periods over which data is compared to the specified threshold.

    • getGroupIdentifier

      @Stability(Stable) @NotNull public String getGroupIdentifier()
      A cloudwatch alarm template group's identifier.

    • setGroupIdentifier

      @Stability(Stable) public void setGroupIdentifier(@NotNull String value)
      A cloudwatch alarm template group's identifier.

    • getMetricName

      @Stability(Stable) @NotNull public String getMetricName()
      The name of the metric associated with the alarm.

    • setMetricName

      @Stability(Stable) public void setMetricName(@NotNull String value)
      The name of the metric associated with the alarm.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A resource's name.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A resource's name.

    • getPeriod

      @Stability(Stable) @NotNull public Number getPeriod()
      The period, in seconds, over which the specified statistic is applied.

    • setPeriod

      @Stability(Stable) public void setPeriod(@NotNull Number value)
      The period, in seconds, over which the specified statistic is applied.

    • getStatistic

      @Stability(Stable) @NotNull public String getStatistic()
      The statistic to apply to the alarm's metric data.

    • setStatistic

      @Stability(Stable) public void setStatistic(@NotNull String value)
      The statistic to apply to the alarm's metric data.

    • getTargetResourceType

      @Stability(Stable) @NotNull public String getTargetResourceType()
      The resource type this template should dynamically generate CloudWatch metric alarms for.

    • setTargetResourceType

      @Stability(Stable) public void setTargetResourceType(@NotNull String value)
      The resource type this template should dynamically generate CloudWatch metric alarms for.

    • getThreshold

      @Stability(Stable) @NotNull public Number getThreshold()
      The threshold value to compare with the specified statistic.

    • setThreshold

      @Stability(Stable) public void setThreshold(@NotNull Number value)
      The threshold value to compare with the specified statistic.

    • getTreatMissingData

      @Stability(Stable) @NotNull public String getTreatMissingData()
      Specifies how missing data points are treated when evaluating the alarm's condition.

    • setTreatMissingData

      @Stability(Stable) public void setTreatMissingData(@NotNull String value)
      Specifies how missing data points are treated when evaluating the alarm's condition.

    • getDatapointsToAlarm

      @Stability(Stable) @Nullable public Number getDatapointsToAlarm()
      The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

    • setDatapointsToAlarm

      @Stability(Stable) public void setDatapointsToAlarm(@Nullable Number value)
      The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A resource's optional description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A resource's optional description.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Represents the tags associated with a resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Represents the tags associated with a resource.