1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. medialive
  5. CloudWatchAlarmTemplate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi

aws-native.medialive.CloudWatchAlarmTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi

    Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type

    Create CloudWatchAlarmTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CloudWatchAlarmTemplate(name: string, args: CloudWatchAlarmTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def CloudWatchAlarmTemplate(resource_name: str,
                                args: CloudWatchAlarmTemplateArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudWatchAlarmTemplate(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                target_resource_type: Optional[CloudWatchAlarmTemplateTargetResourceType] = None,
                                treat_missing_data: Optional[CloudWatchAlarmTemplateTreatMissingData] = None,
                                threshold: Optional[float] = None,
                                evaluation_periods: Optional[float] = None,
                                group_identifier: Optional[str] = None,
                                metric_name: Optional[str] = None,
                                comparison_operator: Optional[CloudWatchAlarmTemplateComparisonOperator] = None,
                                period: Optional[float] = None,
                                statistic: Optional[CloudWatchAlarmTemplateStatistic] = None,
                                name: Optional[str] = None,
                                tags: Optional[Mapping[str, str]] = None,
                                description: Optional[str] = None,
                                datapoints_to_alarm: Optional[float] = None)
    func NewCloudWatchAlarmTemplate(ctx *Context, name string, args CloudWatchAlarmTemplateArgs, opts ...ResourceOption) (*CloudWatchAlarmTemplate, error)
    public CloudWatchAlarmTemplate(string name, CloudWatchAlarmTemplateArgs args, CustomResourceOptions? opts = null)
    public CloudWatchAlarmTemplate(String name, CloudWatchAlarmTemplateArgs args)
    public CloudWatchAlarmTemplate(String name, CloudWatchAlarmTemplateArgs args, CustomResourceOptions options)
    
    type: aws-native:medialive:CloudWatchAlarmTemplate
    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 CloudWatchAlarmTemplateArgs
    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 CloudWatchAlarmTemplateArgs
    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 CloudWatchAlarmTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudWatchAlarmTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudWatchAlarmTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CloudWatchAlarmTemplate 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 CloudWatchAlarmTemplate resource accepts the following input properties:

    ComparisonOperator Pulumi.AwsNative.MediaLive.CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    EvaluationPeriods double
    The number of periods over which data is compared to the specified threshold.
    GroupIdentifier string
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    MetricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    Period double
    The period, in seconds, over which the specified statistic is applied.
    Statistic Pulumi.AwsNative.MediaLive.CloudWatchAlarmTemplateStatistic
    The statistic to apply to the alarm's metric data.
    TargetResourceType Pulumi.AwsNative.MediaLive.CloudWatchAlarmTemplateTargetResourceType
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    Threshold double
    The threshold value to compare with the specified statistic.
    TreatMissingData Pulumi.AwsNative.MediaLive.CloudWatchAlarmTemplateTreatMissingData
    Specifies how missing data points are treated when evaluating the alarm's condition.
    DatapointsToAlarm double
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    Description string
    A resource's optional description.
    Name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    Tags Dictionary<string, string>
    ComparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    EvaluationPeriods float64
    The number of periods over which data is compared to the specified threshold.
    GroupIdentifier string
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    MetricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    Period float64
    The period, in seconds, over which the specified statistic is applied.
    Statistic CloudWatchAlarmTemplateStatistic
    The statistic to apply to the alarm's metric data.
    TargetResourceType CloudWatchAlarmTemplateTargetResourceType
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    Threshold float64
    The threshold value to compare with the specified statistic.
    TreatMissingData CloudWatchAlarmTemplateTreatMissingData
    Specifies how missing data points are treated when evaluating the alarm's condition.
    DatapointsToAlarm float64
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    Description string
    A resource's optional description.
    Name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    Tags map[string]string
    comparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    evaluationPeriods Double
    The number of periods over which data is compared to the specified threshold.
    groupIdentifier String
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    metricName String
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    period Double
    The period, in seconds, over which the specified statistic is applied.
    statistic CloudWatchAlarmTemplateStatistic
    The statistic to apply to the alarm's metric data.
    targetResourceType CloudWatchAlarmTemplateTargetResourceType
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    threshold Double
    The threshold value to compare with the specified statistic.
    treatMissingData CloudWatchAlarmTemplateTreatMissingData
    Specifies how missing data points are treated when evaluating the alarm's condition.
    datapointsToAlarm Double
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    description String
    A resource's optional description.
    name String
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    tags Map<String,String>
    comparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    evaluationPeriods number
    The number of periods over which data is compared to the specified threshold.
    groupIdentifier string
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    metricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    period number
    The period, in seconds, over which the specified statistic is applied.
    statistic CloudWatchAlarmTemplateStatistic
    The statistic to apply to the alarm's metric data.
    targetResourceType CloudWatchAlarmTemplateTargetResourceType
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    threshold number
    The threshold value to compare with the specified statistic.
    treatMissingData CloudWatchAlarmTemplateTreatMissingData
    Specifies how missing data points are treated when evaluating the alarm's condition.
    datapointsToAlarm number
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    description string
    A resource's optional description.
    name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    tags {[key: string]: string}
    comparison_operator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    evaluation_periods float
    The number of periods over which data is compared to the specified threshold.
    group_identifier str
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    metric_name str
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    period float
    The period, in seconds, over which the specified statistic is applied.
    statistic CloudWatchAlarmTemplateStatistic
    The statistic to apply to the alarm's metric data.
    target_resource_type CloudWatchAlarmTemplateTargetResourceType
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    threshold float
    The threshold value to compare with the specified statistic.
    treat_missing_data CloudWatchAlarmTemplateTreatMissingData
    Specifies how missing data points are treated when evaluating the alarm's condition.
    datapoints_to_alarm float
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    description str
    A resource's optional description.
    name str
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    tags Mapping[str, str]
    comparisonOperator "GreaterThanOrEqualToThreshold" | "GreaterThanThreshold" | "LessThanThreshold" | "LessThanOrEqualToThreshold"
    The comparison operator used to compare the specified statistic and the threshold.
    evaluationPeriods Number
    The number of periods over which data is compared to the specified threshold.
    groupIdentifier String
    A cloudwatch alarm template group's identifier. Can be either be its id or current name.
    metricName String
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    period Number
    The period, in seconds, over which the specified statistic is applied.
    statistic "SampleCount" | "Average" | "Sum" | "Minimum" | "Maximum"
    The statistic to apply to the alarm's metric data.
    targetResourceType "CLOUDFRONT_DISTRIBUTION" | "MEDIALIVE_MULTIPLEX" | "MEDIALIVE_CHANNEL" | "MEDIALIVE_INPUT_DEVICE" | "MEDIAPACKAGE_CHANNEL" | "MEDIAPACKAGE_ORIGIN_ENDPOINT" | "MEDIACONNECT_FLOW" | "S3_BUCKET"
    The resource type this template should dynamically generate CloudWatch metric alarms for.
    threshold Number
    The threshold value to compare with the specified statistic.
    treatMissingData "notBreaching" | "breaching" | "ignore" | "missing"
    Specifies how missing data points are treated when evaluating the alarm's condition.
    datapointsToAlarm Number
    The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    description String
    A resource's optional description.
    name String
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    tags Map<String>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CloudWatchAlarmTemplate resource produces the following output properties:

    Arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    AwsId string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    CreatedAt string
    The date and time of resource creation.
    GroupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    ModifiedAt string
    The date and time of latest resource modification.
    Arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    AwsId string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    CreatedAt string
    The date and time of resource creation.
    GroupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    ModifiedAt string
    The date and time of latest resource modification.
    arn String
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    awsId String
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    createdAt String
    The date and time of resource creation.
    groupId String
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    modifiedAt String
    The date and time of latest resource modification.
    arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    awsId string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    createdAt string
    The date and time of resource creation.
    groupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    modifiedAt string
    The date and time of latest resource modification.
    arn str
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    aws_id str
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    created_at str
    The date and time of resource creation.
    group_id str
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    modified_at str
    The date and time of latest resource modification.
    arn String
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    awsId String
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    createdAt String
    The date and time of resource creation.
    groupId String
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    modifiedAt String
    The date and time of latest resource modification.

    Supporting Types

    CloudWatchAlarmTemplateComparisonOperator, CloudWatchAlarmTemplateComparisonOperatorArgs

    GreaterThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    GreaterThanThreshold
    GreaterThanThreshold
    LessThanThreshold
    LessThanThreshold
    LessThanOrEqualToThreshold
    LessThanOrEqualToThreshold
    CloudWatchAlarmTemplateComparisonOperatorGreaterThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    CloudWatchAlarmTemplateComparisonOperatorGreaterThanThreshold
    GreaterThanThreshold
    CloudWatchAlarmTemplateComparisonOperatorLessThanThreshold
    LessThanThreshold
    CloudWatchAlarmTemplateComparisonOperatorLessThanOrEqualToThreshold
    LessThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    GreaterThanThreshold
    GreaterThanThreshold
    LessThanThreshold
    LessThanThreshold
    LessThanOrEqualToThreshold
    LessThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    GreaterThanOrEqualToThreshold
    GreaterThanThreshold
    GreaterThanThreshold
    LessThanThreshold
    LessThanThreshold
    LessThanOrEqualToThreshold
    LessThanOrEqualToThreshold
    GREATER_THAN_OR_EQUAL_TO_THRESHOLD
    GreaterThanOrEqualToThreshold
    GREATER_THAN_THRESHOLD
    GreaterThanThreshold
    LESS_THAN_THRESHOLD
    LessThanThreshold
    LESS_THAN_OR_EQUAL_TO_THRESHOLD
    LessThanOrEqualToThreshold
    "GreaterThanOrEqualToThreshold"
    GreaterThanOrEqualToThreshold
    "GreaterThanThreshold"
    GreaterThanThreshold
    "LessThanThreshold"
    LessThanThreshold
    "LessThanOrEqualToThreshold"
    LessThanOrEqualToThreshold

    CloudWatchAlarmTemplateStatistic, CloudWatchAlarmTemplateStatisticArgs

    SampleCount
    SampleCount
    Average
    Average
    Sum
    Sum
    Minimum
    Minimum
    Maximum
    Maximum
    CloudWatchAlarmTemplateStatisticSampleCount
    SampleCount
    CloudWatchAlarmTemplateStatisticAverage
    Average
    CloudWatchAlarmTemplateStatisticSum
    Sum
    CloudWatchAlarmTemplateStatisticMinimum
    Minimum
    CloudWatchAlarmTemplateStatisticMaximum
    Maximum
    SampleCount
    SampleCount
    Average
    Average
    Sum
    Sum
    Minimum
    Minimum
    Maximum
    Maximum
    SampleCount
    SampleCount
    Average
    Average
    Sum
    Sum
    Minimum
    Minimum
    Maximum
    Maximum
    SAMPLE_COUNT
    SampleCount
    AVERAGE
    Average
    SUM
    Sum
    MINIMUM
    Minimum
    MAXIMUM
    Maximum
    "SampleCount"
    SampleCount
    "Average"
    Average
    "Sum"
    Sum
    "Minimum"
    Minimum
    "Maximum"
    Maximum

    CloudWatchAlarmTemplateTargetResourceType, CloudWatchAlarmTemplateTargetResourceTypeArgs

    CloudfrontDistribution
    CLOUDFRONT_DISTRIBUTION
    MedialiveMultiplex
    MEDIALIVE_MULTIPLEX
    MedialiveChannel
    MEDIALIVE_CHANNEL
    MedialiveInputDevice
    MEDIALIVE_INPUT_DEVICE
    MediapackageChannel
    MEDIAPACKAGE_CHANNEL
    MediapackageOriginEndpoint
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    MediaconnectFlow
    MEDIACONNECT_FLOW
    S3Bucket
    S3_BUCKET
    CloudWatchAlarmTemplateTargetResourceTypeCloudfrontDistribution
    CLOUDFRONT_DISTRIBUTION
    CloudWatchAlarmTemplateTargetResourceTypeMedialiveMultiplex
    MEDIALIVE_MULTIPLEX
    CloudWatchAlarmTemplateTargetResourceTypeMedialiveChannel
    MEDIALIVE_CHANNEL
    CloudWatchAlarmTemplateTargetResourceTypeMedialiveInputDevice
    MEDIALIVE_INPUT_DEVICE
    CloudWatchAlarmTemplateTargetResourceTypeMediapackageChannel
    MEDIAPACKAGE_CHANNEL
    CloudWatchAlarmTemplateTargetResourceTypeMediapackageOriginEndpoint
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    CloudWatchAlarmTemplateTargetResourceTypeMediaconnectFlow
    MEDIACONNECT_FLOW
    CloudWatchAlarmTemplateTargetResourceTypeS3Bucket
    S3_BUCKET
    CloudfrontDistribution
    CLOUDFRONT_DISTRIBUTION
    MedialiveMultiplex
    MEDIALIVE_MULTIPLEX
    MedialiveChannel
    MEDIALIVE_CHANNEL
    MedialiveInputDevice
    MEDIALIVE_INPUT_DEVICE
    MediapackageChannel
    MEDIAPACKAGE_CHANNEL
    MediapackageOriginEndpoint
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    MediaconnectFlow
    MEDIACONNECT_FLOW
    S3Bucket
    S3_BUCKET
    CloudfrontDistribution
    CLOUDFRONT_DISTRIBUTION
    MedialiveMultiplex
    MEDIALIVE_MULTIPLEX
    MedialiveChannel
    MEDIALIVE_CHANNEL
    MedialiveInputDevice
    MEDIALIVE_INPUT_DEVICE
    MediapackageChannel
    MEDIAPACKAGE_CHANNEL
    MediapackageOriginEndpoint
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    MediaconnectFlow
    MEDIACONNECT_FLOW
    S3Bucket
    S3_BUCKET
    CLOUDFRONT_DISTRIBUTION
    CLOUDFRONT_DISTRIBUTION
    MEDIALIVE_MULTIPLEX
    MEDIALIVE_MULTIPLEX
    MEDIALIVE_CHANNEL
    MEDIALIVE_CHANNEL
    MEDIALIVE_INPUT_DEVICE
    MEDIALIVE_INPUT_DEVICE
    MEDIAPACKAGE_CHANNEL
    MEDIAPACKAGE_CHANNEL
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    MEDIACONNECT_FLOW
    MEDIACONNECT_FLOW
    S3_BUCKET
    S3_BUCKET
    "CLOUDFRONT_DISTRIBUTION"
    CLOUDFRONT_DISTRIBUTION
    "MEDIALIVE_MULTIPLEX"
    MEDIALIVE_MULTIPLEX
    "MEDIALIVE_CHANNEL"
    MEDIALIVE_CHANNEL
    "MEDIALIVE_INPUT_DEVICE"
    MEDIALIVE_INPUT_DEVICE
    "MEDIAPACKAGE_CHANNEL"
    MEDIAPACKAGE_CHANNEL
    "MEDIAPACKAGE_ORIGIN_ENDPOINT"
    MEDIAPACKAGE_ORIGIN_ENDPOINT
    "MEDIACONNECT_FLOW"
    MEDIACONNECT_FLOW
    "S3_BUCKET"
    S3_BUCKET

    CloudWatchAlarmTemplateTreatMissingData, CloudWatchAlarmTemplateTreatMissingDataArgs

    NotBreaching
    notBreaching
    Breaching
    breaching
    Ignore
    ignore
    Missing
    missing
    CloudWatchAlarmTemplateTreatMissingDataNotBreaching
    notBreaching
    CloudWatchAlarmTemplateTreatMissingDataBreaching
    breaching
    CloudWatchAlarmTemplateTreatMissingDataIgnore
    ignore
    CloudWatchAlarmTemplateTreatMissingDataMissing
    missing
    NotBreaching
    notBreaching
    Breaching
    breaching
    Ignore
    ignore
    Missing
    missing
    NotBreaching
    notBreaching
    Breaching
    breaching
    Ignore
    ignore
    Missing
    missing
    NOT_BREACHING
    notBreaching
    BREACHING
    breaching
    IGNORE
    ignore
    MISSING
    missing
    "notBreaching"
    notBreaching
    "breaching"
    breaching
    "ignore"
    ignore
    "missing"
    missing

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.8.0 published on Thursday, Nov 14, 2024 by Pulumi