We recommend new projects start with resources from the AWS provider.
aws-native.medialive.CloudWatchAlarmTemplate
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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,
                            statistic: Optional[CloudWatchAlarmTemplateStatistic] = None,
                            treat_missing_data: Optional[CloudWatchAlarmTemplateTreatMissingData] = None,
                            threshold: Optional[float] = None,
                            evaluation_periods: Optional[float] = None,
                            target_resource_type: Optional[CloudWatchAlarmTemplateTargetResourceType] = None,
                            metric_name: Optional[str] = None,
                            comparison_operator: Optional[CloudWatchAlarmTemplateComparisonOperator] = None,
                            period: Optional[float] = None,
                            name: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            group_identifier: Optional[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.Aws Native. Media Live. Cloud Watch Alarm Template Comparison Operator 
- 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.
- 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.Aws Native. Media Live. Cloud Watch Alarm Template Statistic 
- The statistic to apply to the alarm's metric data.
- TargetResource Pulumi.Type Aws Native. Media Live. Cloud Watch Alarm Template Target Resource Type 
- The resource type this template should dynamically generate CloudWatch metric alarms for.
- Threshold double
- The threshold value to compare with the specified statistic.
- TreatMissing Pulumi.Data Aws Native. Media Live. Cloud Watch Alarm Template Treat Missing Data 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- DatapointsTo doubleAlarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description string
- A resource's optional description.
- GroupIdentifier string
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- Name string
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Dictionary<string, string>
- ComparisonOperator CloudWatch Alarm Template Comparison Operator 
- 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.
- 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
CloudWatch Alarm Template Statistic 
- The statistic to apply to the alarm's metric data.
- TargetResource CloudType Watch Alarm Template Target Resource Type 
- The resource type this template should dynamically generate CloudWatch metric alarms for.
- Threshold float64
- The threshold value to compare with the specified statistic.
- TreatMissing CloudData Watch Alarm Template Treat Missing Data 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- DatapointsTo float64Alarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description string
- A resource's optional description.
- GroupIdentifier string
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- Name string
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- map[string]string
- comparisonOperator CloudWatch Alarm Template Comparison Operator 
- 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.
- 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
CloudWatch Alarm Template Statistic 
- The statistic to apply to the alarm's metric data.
- targetResource CloudType Watch Alarm Template Target Resource Type 
- The resource type this template should dynamically generate CloudWatch metric alarms for.
- threshold Double
- The threshold value to compare with the specified statistic.
- treatMissing CloudData Watch Alarm Template Treat Missing Data 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- datapointsTo DoubleAlarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description String
- A resource's optional description.
- groupIdentifier String
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- name String
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Map<String,String>
- comparisonOperator CloudWatch Alarm Template Comparison Operator 
- 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.
- 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
CloudWatch Alarm Template Statistic 
- The statistic to apply to the alarm's metric data.
- targetResource CloudType Watch Alarm Template Target Resource Type 
- The resource type this template should dynamically generate CloudWatch metric alarms for.
- threshold number
- The threshold value to compare with the specified statistic.
- treatMissing CloudData Watch Alarm Template Treat Missing Data 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- datapointsTo numberAlarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description string
- A resource's optional description.
- groupIdentifier string
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- name string
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- {[key: string]: string}
- comparison_operator CloudWatch Alarm Template Comparison Operator 
- 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.
- 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
CloudWatch Alarm Template Statistic 
- The statistic to apply to the alarm's metric data.
- target_resource_ Cloudtype Watch Alarm Template Target Resource Type 
- 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_ Clouddata Watch Alarm Template Treat Missing Data 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- datapoints_to_ floatalarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description str
- A resource's optional description.
- group_identifier str
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- name str
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Mapping[str, str]
- comparisonOperator "GreaterThan Or Equal To Threshold" | "Greater Than Threshold" | "Less Than Threshold" | "Less Than Or Equal To Threshold" 
- 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.
- 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.
- targetResource "CLOUDFRONT_DISTRIBUTION" | "MEDIALIVE_MULTIPLEX" | "MEDIALIVE_CHANNEL" | "MEDIALIVE_INPUT_DEVICE" | "MEDIAPACKAGE_CHANNEL" | "MEDIAPACKAGE_ORIGIN_ENDPOINT" | "MEDIACONNECT_FLOW" | "MEDIATAILOR_PLAYBACK_CONFIGURATION" | "S3_BUCKET"Type 
- The resource type this template should dynamically generate CloudWatch metric alarms for.
- threshold Number
- The threshold value to compare with the specified statistic.
- treatMissing "notData Breaching" | "breaching" | "ignore" | "missing" 
- Specifies how missing data points are treated when evaluating the alarm's condition.
- datapointsTo NumberAlarm 
- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description String
- A resource's optional description.
- groupIdentifier String
- A cloudwatch alarm template group's identifier. Can be either be its id or current name.
- name String
- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- 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            
- GreaterThan Or Equal To Threshold 
- GreaterThanOrEqualToThreshold
- GreaterThan Threshold 
- GreaterThanThreshold
- LessThan Threshold 
- LessThanThreshold
- LessThan Or Equal To Threshold 
- LessThanOrEqualToThreshold
- CloudWatch Alarm Template Comparison Operator Greater Than Or Equal To Threshold 
- GreaterThanOrEqualToThreshold
- CloudWatch Alarm Template Comparison Operator Greater Than Threshold 
- GreaterThanThreshold
- CloudWatch Alarm Template Comparison Operator Less Than Threshold 
- LessThanThreshold
- CloudWatch Alarm Template Comparison Operator Less Than Or Equal To Threshold 
- LessThanOrEqualToThreshold
- GreaterThan Or Equal To Threshold 
- GreaterThanOrEqualToThreshold
- GreaterThan Threshold 
- GreaterThanThreshold
- LessThan Threshold 
- LessThanThreshold
- LessThan Or Equal To Threshold 
- LessThanOrEqualToThreshold
- GreaterThan Or Equal To Threshold 
- GreaterThanOrEqualToThreshold
- GreaterThan Threshold 
- GreaterThanThreshold
- LessThan Threshold 
- LessThanThreshold
- LessThan Or Equal To Threshold 
- LessThanOrEqualToThreshold
- GREATER_THAN_OR_EQUAL_TO_THRESHOLD
- GreaterThanOrEqualToThreshold
- GREATER_THAN_THRESHOLD
- GreaterThanThreshold
- LESS_THAN_THRESHOLD
- LessThanThreshold
- LESS_THAN_OR_EQUAL_TO_THRESHOLD
- LessThanOrEqualToThreshold
- "GreaterThan Or Equal To Threshold" 
- GreaterThanOrEqualToThreshold
- "GreaterThan Threshold" 
- GreaterThanThreshold
- "LessThan Threshold" 
- LessThanThreshold
- "LessThan Or Equal To Threshold" 
- LessThanOrEqualToThreshold
CloudWatchAlarmTemplateStatistic, CloudWatchAlarmTemplateStatisticArgs          
- SampleCount 
- SampleCount
- Average
- Average
- Sum
- Sum
- Minimum
- Minimum
- Maximum
- Maximum
- CloudWatch Alarm Template Statistic Sample Count 
- SampleCount
- CloudWatch Alarm Template Statistic Average 
- Average
- CloudWatch Alarm Template Statistic Sum 
- Sum
- CloudWatch Alarm Template Statistic Minimum 
- Minimum
- CloudWatch Alarm Template Statistic Maximum 
- 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
- MedialiveInput Device 
- MEDIALIVE_INPUT_DEVICE
- MediapackageChannel 
- MEDIAPACKAGE_CHANNEL
- MediapackageOrigin Endpoint 
- MEDIAPACKAGE_ORIGIN_ENDPOINT
- MediaconnectFlow 
- MEDIACONNECT_FLOW
- MediatailorPlayback Configuration 
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- S3Bucket
- S3_BUCKET
- CloudWatch Alarm Template Target Resource Type Cloudfront Distribution 
- CLOUDFRONT_DISTRIBUTION
- CloudWatch Alarm Template Target Resource Type Medialive Multiplex 
- MEDIALIVE_MULTIPLEX
- CloudWatch Alarm Template Target Resource Type Medialive Channel 
- MEDIALIVE_CHANNEL
- CloudWatch Alarm Template Target Resource Type Medialive Input Device 
- MEDIALIVE_INPUT_DEVICE
- CloudWatch Alarm Template Target Resource Type Mediapackage Channel 
- MEDIAPACKAGE_CHANNEL
- CloudWatch Alarm Template Target Resource Type Mediapackage Origin Endpoint 
- MEDIAPACKAGE_ORIGIN_ENDPOINT
- CloudWatch Alarm Template Target Resource Type Mediaconnect Flow 
- MEDIACONNECT_FLOW
- CloudWatch Alarm Template Target Resource Type Mediatailor Playback Configuration 
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- CloudWatch Alarm Template Target Resource Type S3Bucket 
- S3_BUCKET
- CloudfrontDistribution 
- CLOUDFRONT_DISTRIBUTION
- MedialiveMultiplex 
- MEDIALIVE_MULTIPLEX
- MedialiveChannel 
- MEDIALIVE_CHANNEL
- MedialiveInput Device 
- MEDIALIVE_INPUT_DEVICE
- MediapackageChannel 
- MEDIAPACKAGE_CHANNEL
- MediapackageOrigin Endpoint 
- MEDIAPACKAGE_ORIGIN_ENDPOINT
- MediaconnectFlow 
- MEDIACONNECT_FLOW
- MediatailorPlayback Configuration 
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- S3Bucket
- S3_BUCKET
- CloudfrontDistribution 
- CLOUDFRONT_DISTRIBUTION
- MedialiveMultiplex 
- MEDIALIVE_MULTIPLEX
- MedialiveChannel 
- MEDIALIVE_CHANNEL
- MedialiveInput Device 
- MEDIALIVE_INPUT_DEVICE
- MediapackageChannel 
- MEDIAPACKAGE_CHANNEL
- MediapackageOrigin Endpoint 
- MEDIAPACKAGE_ORIGIN_ENDPOINT
- MediaconnectFlow 
- MEDIACONNECT_FLOW
- MediatailorPlayback Configuration 
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- 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
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- 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
- "MEDIATAILOR_PLAYBACK_CONFIGURATION"
- MEDIATAILOR_PLAYBACK_CONFIGURATION
- "S3_BUCKET"
- S3_BUCKET
CloudWatchAlarmTemplateTreatMissingData, CloudWatchAlarmTemplateTreatMissingDataArgs              
- NotBreaching 
- notBreaching
- Breaching
- breaching
- Ignore
- ignore
- Missing
- missing
- CloudWatch Alarm Template Treat Missing Data Not Breaching 
- notBreaching
- CloudWatch Alarm Template Treat Missing Data Breaching 
- breaching
- CloudWatch Alarm Template Treat Missing Data Ignore 
- ignore
- CloudWatch Alarm Template Treat Missing Data Missing 
- 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
We recommend new projects start with resources from the AWS provider.