1. Packages
  2. AWS Native
  3. API Docs
  4. medialive
  5. getCloudWatchAlarmTemplate

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.medialive.getCloudWatchAlarmTemplate

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type

    Using getCloudWatchAlarmTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudWatchAlarmTemplate(args: GetCloudWatchAlarmTemplateArgs, opts?: InvokeOptions): Promise<GetCloudWatchAlarmTemplateResult>
    function getCloudWatchAlarmTemplateOutput(args: GetCloudWatchAlarmTemplateOutputArgs, opts?: InvokeOptions): Output<GetCloudWatchAlarmTemplateResult>
    def get_cloud_watch_alarm_template(identifier: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetCloudWatchAlarmTemplateResult
    def get_cloud_watch_alarm_template_output(identifier: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetCloudWatchAlarmTemplateResult]
    func LookupCloudWatchAlarmTemplate(ctx *Context, args *LookupCloudWatchAlarmTemplateArgs, opts ...InvokeOption) (*LookupCloudWatchAlarmTemplateResult, error)
    func LookupCloudWatchAlarmTemplateOutput(ctx *Context, args *LookupCloudWatchAlarmTemplateOutputArgs, opts ...InvokeOption) LookupCloudWatchAlarmTemplateResultOutput

    > Note: This function is named LookupCloudWatchAlarmTemplate in the Go SDK.

    public static class GetCloudWatchAlarmTemplate 
    {
        public static Task<GetCloudWatchAlarmTemplateResult> InvokeAsync(GetCloudWatchAlarmTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudWatchAlarmTemplateResult> Invoke(GetCloudWatchAlarmTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudWatchAlarmTemplateResult> getCloudWatchAlarmTemplate(GetCloudWatchAlarmTemplateArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:medialive:getCloudWatchAlarmTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Identifier string
    Identifier string
    identifier String
    identifier string
    identifier String

    getCloudWatchAlarmTemplate Result

    The following output properties are available:

    Arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    ComparisonOperator Pulumi.AwsNative.MediaLive.CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    CreatedAt string
    The date and time of resource creation.
    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.
    EvaluationPeriods double
    The number of periods over which data is compared to the specified threshold.
    GroupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    Id string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    Identifier string
    MetricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    ModifiedAt string
    The date and time of latest resource modification.
    Name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.
    Arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    ComparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    CreatedAt string
    The date and time of resource creation.
    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.
    EvaluationPeriods float64
    The number of periods over which data is compared to the specified threshold.
    GroupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    Id string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    Identifier string
    MetricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    ModifiedAt string
    The date and time of latest resource modification.
    Name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.
    arn String
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    comparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    createdAt String
    The date and time of resource creation.
    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.
    evaluationPeriods Double
    The number of periods over which data is compared to the specified threshold.
    groupId String
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id String
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    identifier String
    metricName String
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    modifiedAt String
    The date and time of latest resource modification.
    name String
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.
    arn string
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    comparisonOperator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    createdAt string
    The date and time of resource creation.
    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.
    evaluationPeriods number
    The number of periods over which data is compared to the specified threshold.
    groupId string
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id string
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    identifier string
    metricName string
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    modifiedAt string
    The date and time of latest resource modification.
    name string
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.
    arn str
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    comparison_operator CloudWatchAlarmTemplateComparisonOperator
    The comparison operator used to compare the specified statistic and the threshold.
    created_at str
    The date and time of resource creation.
    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.
    evaluation_periods float
    The number of periods over which data is compared to the specified threshold.
    group_id str
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id str
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    identifier str
    metric_name str
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    modified_at str
    The date and time of latest resource modification.
    name str
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.
    arn String
    A cloudwatch alarm template's ARN (Amazon Resource Name)
    comparisonOperator "GreaterThanOrEqualToThreshold" | "GreaterThanThreshold" | "LessThanThreshold" | "LessThanOrEqualToThreshold"
    The comparison operator used to compare the specified statistic and the threshold.
    createdAt String
    The date and time of resource creation.
    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.
    evaluationPeriods Number
    The number of periods over which data is compared to the specified threshold.
    groupId String
    A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    id String
    A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    identifier String
    metricName String
    The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    modifiedAt String
    The date and time of latest resource modification.
    name String
    A resource's name. Names must be unique within the scope of a resource type in a specific region.
    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.

    Supporting Types

    CloudWatchAlarmTemplateComparisonOperator

    CloudWatchAlarmTemplateStatistic

    CloudWatchAlarmTemplateTargetResourceType

    CloudWatchAlarmTemplateTreatMissingData

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi