We recommend new projects start with resources from the AWS provider.
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:
- Comparison
Operator Pulumi.Aws Native. Media Live. Cloud Watch Alarm Template Comparison Operator - The comparison operator used to compare the specified statistic and the threshold.
- Evaluation
Periods double - The number of periods over which data is compared to the specified threshold.
- Metric
Name 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.
- Target
Resource 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.
- Treat
Missing 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.
- Datapoints
To doubleAlarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description string
- A resource's optional description.
- Group
Identifier 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>
- Comparison
Operator CloudWatch Alarm Template Comparison Operator - The comparison operator used to compare the specified statistic and the threshold.
- Evaluation
Periods float64 - The number of periods over which data is compared to the specified threshold.
- Metric
Name 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
Cloud
Watch 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 float64
- 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 float64Alarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description string
- A resource's optional description.
- Group
Identifier 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
- comparison
Operator CloudWatch Alarm Template Comparison Operator - The comparison operator used to compare the specified statistic and the threshold.
- evaluation
Periods Double - The number of periods over which data is compared to the specified threshold.
- metric
Name 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
Cloud
Watch 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 Double
- 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 DoubleAlarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description String
- A resource's optional description.
- group
Identifier 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>
- comparison
Operator CloudWatch Alarm Template Comparison Operator - The comparison operator used to compare the specified statistic and the threshold.
- evaluation
Periods number - The number of periods over which data is compared to the specified threshold.
- metric
Name 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
Cloud
Watch 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 number
- 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 numberAlarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description string
- A resource's optional description.
- group
Identifier 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
Cloud
Watch 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]
- comparison
Operator "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.
- evaluation
Periods Number - The number of periods over which data is compared to the specified threshold.
- metric
Name 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
"Sample
Count" | "Average" | "Sum" | "Minimum" | "Maximum" - The statistic to apply to the alarm's metric data.
- target
Resource "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.
- treat
Missing "notData Breaching" | "breaching" | "ignore" | "missing" - Specifies how missing data points are treated when evaluating the alarm's condition.
- datapoints
To NumberAlarm - The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- description String
- A resource's optional description.
- group
Identifier 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)
- Aws
Id string - A cloudwatch alarm template's id. AWS provided templates have ids that start with
aws- - Created
At string - The date and time of resource creation.
- Group
Id 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
- Modified
At string - The date and time of latest resource modification.
- Arn string
- A cloudwatch alarm template's ARN (Amazon Resource Name)
- Aws
Id string - A cloudwatch alarm template's id. AWS provided templates have ids that start with
aws- - Created
At string - The date and time of resource creation.
- Group
Id 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
- Modified
At string - The date and time of latest resource modification.
- arn String
- A cloudwatch alarm template's ARN (Amazon Resource Name)
- aws
Id String - A cloudwatch alarm template's id. AWS provided templates have ids that start with
aws- - created
At String - The date and time of resource creation.
- group
Id 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
- modified
At String - The date and time of latest resource modification.
- arn string
- A cloudwatch alarm template's ARN (Amazon Resource Name)
- aws
Id string - A cloudwatch alarm template's id. AWS provided templates have ids that start with
aws- - created
At string - The date and time of resource creation.
- group
Id 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
- modified
At 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)
- aws
Id String - A cloudwatch alarm template's id. AWS provided templates have ids that start with
aws- - created
At String - The date and time of resource creation.
- group
Id 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
- modified
At String - The date and time of latest resource modification.
Supporting Types
CloudWatchAlarmTemplateComparisonOperator, CloudWatchAlarmTemplateComparisonOperatorArgs
- Greater
Than Or Equal To Threshold GreaterThanOrEqualToThreshold- Greater
Than Threshold GreaterThanThreshold- Less
Than Threshold LessThanThreshold- Less
Than Or Equal To Threshold LessThanOrEqualToThreshold
- Cloud
Watch Alarm Template Comparison Operator Greater Than Or Equal To Threshold GreaterThanOrEqualToThreshold- Cloud
Watch Alarm Template Comparison Operator Greater Than Threshold GreaterThanThreshold- Cloud
Watch Alarm Template Comparison Operator Less Than Threshold LessThanThreshold- Cloud
Watch Alarm Template Comparison Operator Less Than 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
- Greater
Than Or Equal To Threshold GreaterThanOrEqualToThreshold- Greater
Than Threshold GreaterThanThreshold- Less
Than Threshold LessThanThreshold- Less
Than 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
- "Greater
Than Or Equal To Threshold" GreaterThanOrEqualToThreshold- "Greater
Than Threshold" GreaterThanThreshold- "Less
Than Threshold" LessThanThreshold- "Less
Than Or Equal To Threshold" LessThanOrEqualToThreshold
CloudWatchAlarmTemplateStatistic, CloudWatchAlarmTemplateStatisticArgs
- Sample
Count SampleCount- Average
Average- Sum
Sum- Minimum
Minimum- Maximum
Maximum
- Cloud
Watch Alarm Template Statistic Sample Count SampleCount- Cloud
Watch Alarm Template Statistic Average Average- Cloud
Watch Alarm Template Statistic Sum Sum- Cloud
Watch Alarm Template Statistic Minimum Minimum- Cloud
Watch Alarm Template Statistic Maximum Maximum
- Sample
Count SampleCount- Average
Average- Sum
Sum- Minimum
Minimum- Maximum
Maximum
- Sample
Count SampleCount- Average
Average- Sum
Sum- Minimum
Minimum- Maximum
Maximum
- SAMPLE_COUNT
SampleCount- AVERAGE
Average- SUM
Sum- MINIMUM
Minimum- MAXIMUM
Maximum
- "Sample
Count" SampleCount- "Average"
Average- "Sum"
Sum- "Minimum"
Minimum- "Maximum"
Maximum
CloudWatchAlarmTemplateTargetResourceType, CloudWatchAlarmTemplateTargetResourceTypeArgs
- 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- S3Bucket
S3_BUCKET
- Cloud
Watch Alarm Template Target Resource Type Cloudfront Distribution CLOUDFRONT_DISTRIBUTION- Cloud
Watch Alarm Template Target Resource Type Medialive Multiplex MEDIALIVE_MULTIPLEX- Cloud
Watch Alarm Template Target Resource Type Medialive Channel MEDIALIVE_CHANNEL- Cloud
Watch Alarm Template Target Resource Type Medialive Input Device MEDIALIVE_INPUT_DEVICE- Cloud
Watch Alarm Template Target Resource Type Mediapackage Channel MEDIAPACKAGE_CHANNEL- Cloud
Watch Alarm Template Target Resource Type Mediapackage Origin Endpoint MEDIAPACKAGE_ORIGIN_ENDPOINT- Cloud
Watch Alarm Template Target Resource Type Mediaconnect Flow MEDIACONNECT_FLOW- Cloud
Watch Alarm Template Target Resource Type Mediatailor Playback Configuration MEDIATAILOR_PLAYBACK_CONFIGURATION- Cloud
Watch Alarm Template Target Resource Type 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- 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- 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
- Not
Breaching notBreaching- Breaching
breaching- Ignore
ignore- Missing
missing
- Cloud
Watch Alarm Template Treat Missing Data Not Breaching notBreaching- Cloud
Watch Alarm Template Treat Missing Data Breaching breaching- Cloud
Watch Alarm Template Treat Missing Data Ignore ignore- Cloud
Watch Alarm Template Treat Missing Data Missing missing
- Not
Breaching notBreaching- Breaching
breaching- Ignore
ignore- Missing
missing
- Not
Breaching notBreaching- Breaching
breaching- Ignore
ignore- Missing
missing
- NOT_BREACHING
notBreaching- BREACHING
breaching- IGNORE
ignore- MISSING
missing
- "not
Breaching" 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.
