aws_sdk_medialive/client/
create_cloud_watch_alarm_template.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateCloudWatchAlarmTemplate`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`comparison_operator(CloudWatchAlarmTemplateComparisonOperator)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::comparison_operator) / [`set_comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_comparison_operator):<br>required: **true**<br>The comparison operator used to compare the specified statistic and the threshold.<br>
7    ///   - [`datapoints_to_alarm(i32)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::datapoints_to_alarm) / [`set_datapoints_to_alarm(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_datapoints_to_alarm):<br>required: **false**<br>The number of datapoints within the evaluation period that must be breaching to trigger the alarm.<br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_description):<br>required: **false**<br>A resource's optional description.<br>
9    ///   - [`evaluation_periods(i32)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::evaluation_periods) / [`set_evaluation_periods(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_evaluation_periods):<br>required: **true**<br>The number of periods over which data is compared to the specified threshold.<br>
10    ///   - [`group_identifier(impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::group_identifier) / [`set_group_identifier(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_group_identifier):<br>required: **true**<br>A cloudwatch alarm template group's identifier. Can be either be its id or current name.<br>
11    ///   - [`metric_name(impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::metric_name) / [`set_metric_name(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_metric_name):<br>required: **true**<br>The name of the metric associated with the alarm. Must be compatible with targetResourceType.<br>
12    ///   - [`name(impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_name):<br>required: **true**<br>A resource's name. Names must be unique within the scope of a resource type in a specific region.<br>
13    ///   - [`period(i32)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::period) / [`set_period(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_period):<br>required: **true**<br>The period, in seconds, over which the specified statistic is applied.<br>
14    ///   - [`statistic(CloudWatchAlarmTemplateStatistic)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::statistic) / [`set_statistic(Option<CloudWatchAlarmTemplateStatistic>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_statistic):<br>required: **true**<br>The statistic to apply to the alarm's metric data.<br>
15    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_tags):<br>required: **false**<br>Represents the tags associated with a resource.<br>
16    ///   - [`target_resource_type(CloudWatchAlarmTemplateTargetResourceType)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::target_resource_type) / [`set_target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_target_resource_type):<br>required: **true**<br>The resource type this template should dynamically generate cloudwatch metric alarms for.<br>
17    ///   - [`threshold(f64)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::threshold) / [`set_threshold(Option<f64>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_threshold):<br>required: **true**<br>The threshold value to compare with the specified statistic.<br>
18    ///   - [`treat_missing_data(CloudWatchAlarmTemplateTreatMissingData)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::treat_missing_data) / [`set_treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_treat_missing_data):<br>required: **true**<br>Specifies how missing data points are treated when evaluating the alarm's condition.<br>
19    ///   - [`request_id(impl Into<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::set_request_id):<br>required: **false**<br>An ID that you assign to a create request. This ID ensures idempotency when creating resources.<br>
20    /// - On success, responds with [`CreateCloudWatchAlarmTemplateOutput`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput) with field(s):
21    ///   - [`arn(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::arn): A cloudwatch alarm template's ARN (Amazon Resource Name)
22    ///   - [`comparison_operator(Option<CloudWatchAlarmTemplateComparisonOperator>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::comparison_operator): The comparison operator used to compare the specified statistic and the threshold.
23    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::created_at): Placeholder documentation for __timestampIso8601
24    ///   - [`datapoints_to_alarm(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::datapoints_to_alarm): The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
25    ///   - [`description(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::description): A resource's optional description.
26    ///   - [`evaluation_periods(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::evaluation_periods): The number of periods over which data is compared to the specified threshold.
27    ///   - [`group_id(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::group_id): A cloudwatch alarm template group's id. AWS provided template groups have ids that start with `aws-`
28    ///   - [`id(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::id): A cloudwatch alarm template's id. AWS provided templates have ids that start with `aws-`
29    ///   - [`metric_name(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::metric_name): The name of the metric associated with the alarm. Must be compatible with targetResourceType.
30    ///   - [`modified_at(Option<DateTime>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::modified_at): Placeholder documentation for __timestampIso8601
31    ///   - [`name(Option<String>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::name): A resource's name. Names must be unique within the scope of a resource type in a specific region.
32    ///   - [`period(Option<i32>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::period): The period, in seconds, over which the specified statistic is applied.
33    ///   - [`statistic(Option<CloudWatchAlarmTemplateStatistic>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::statistic): The statistic to apply to the alarm's metric data.
34    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::tags): Represents the tags associated with a resource.
35    ///   - [`target_resource_type(Option<CloudWatchAlarmTemplateTargetResourceType>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::target_resource_type): The resource type this template should dynamically generate cloudwatch metric alarms for.
36    ///   - [`threshold(Option<f64>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::threshold): The threshold value to compare with the specified statistic.
37    ///   - [`treat_missing_data(Option<CloudWatchAlarmTemplateTreatMissingData>)`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateOutput::treat_missing_data): Specifies how missing data points are treated when evaluating the alarm's condition.
38    /// - On failure, responds with [`SdkError<CreateCloudWatchAlarmTemplateError>`](crate::operation::create_cloud_watch_alarm_template::CreateCloudWatchAlarmTemplateError)
39    pub fn create_cloud_watch_alarm_template(
40        &self,
41    ) -> crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder {
42        crate::operation::create_cloud_watch_alarm_template::builders::CreateCloudWatchAlarmTemplateFluentBuilder::new(self.handle.clone())
43    }
44}
aws_sdk_medialive/client/create_cloud_watch_alarm_template.rs

aws_sdk_medialive/client/
create_cloud_watch_alarm_template.rs
