1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_maintenance_window_task::_update_maintenance_window_task_output::UpdateMaintenanceWindowTaskOutputBuilder;
pub use crate::operation::update_maintenance_window_task::_update_maintenance_window_task_input::UpdateMaintenanceWindowTaskInputBuilder;
/// Fluent builder constructing a request to `UpdateMaintenanceWindowTask`.
///
/// <p>Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:</p>
/// <ul>
/// <li> <p> <code>TaskARN</code>. For example, you can change a <code>RUN_COMMAND</code> task from <code>AWS-RunPowerShellScript</code> to <code>AWS-RunShellScript</code>.</p> </li>
/// <li> <p> <code>ServiceRoleArn</code> </p> </li>
/// <li> <p> <code>TaskInvocationParameters</code> </p> </li>
/// <li> <p> <code>Priority</code> </p> </li>
/// <li> <p> <code>MaxConcurrency</code> </p> </li>
/// <li> <p> <code>MaxErrors</code> </p> </li>
/// </ul> <note>
/// <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
/// </note>
/// <p>If the value for a parameter in <code>UpdateMaintenanceWindowTask</code> is null, then the corresponding field isn't modified. If you set <code>Replace</code> to true, then all fields required by the <code>RegisterTaskWithMaintenanceWindow</code> operation are required for this request. Optional fields that aren't specified are set to null.</p> <important>
/// <p>When you update a maintenance window task that has options specified in <code>TaskInvocationParameters</code>, you must provide again all the <code>TaskInvocationParameters</code> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <code>TaskInvocationParameters</code> values for <code>Comment</code>, <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p>
/// </important>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateMaintenanceWindowTaskFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_maintenance_window_task::builders::UpdateMaintenanceWindowTaskInputBuilder
}
impl UpdateMaintenanceWindowTaskFluentBuilder {
/// Creates a new `UpdateMaintenanceWindowTask`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::update_maintenance_window_task::UpdateMaintenanceWindowTask,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::update_maintenance_window_task::UpdateMaintenanceWindowTaskError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::update_maintenance_window_task::UpdateMaintenanceWindowTaskOutput,
aws_smithy_http::result::SdkError<
crate::operation::update_maintenance_window_task::UpdateMaintenanceWindowTaskError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The maintenance window ID that contains the task to modify.</p>
pub fn window_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.window_id(input.into());
self
}
/// <p>The maintenance window ID that contains the task to modify.</p>
pub fn set_window_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_window_id(input);
self
}
/// <p>The task ID to modify.</p>
pub fn window_task_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.window_task_id(input.into());
self
}
/// <p>The task ID to modify.</p>
pub fn set_window_task_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_window_task_id(input);
self
}
/// Appends an item to `Targets`.
///
/// To override the contents of this collection use [`set_targets`](Self::set_targets).
///
/// <p>The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format <code>Key=instanceids,Values=instanceID_1,instanceID_2</code>. Tags are specified using the format <code> Key=tag_name,Values=tag_value</code>. </p> <note>
/// <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
/// </note>
pub fn targets(mut self, input: crate::types::Target) -> Self {
self.inner = self.inner.targets(input);
self
}
/// <p>The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format <code>Key=instanceids,Values=instanceID_1,instanceID_2</code>. Tags are specified using the format <code> Key=tag_name,Values=tag_value</code>. </p> <note>
/// <p>One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
/// </note>
pub fn set_targets(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::Target>>,
) -> Self {
self.inner = self.inner.set_targets(input);
self
}
/// <p>The task ARN to modify.</p>
pub fn task_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.task_arn(input.into());
self
}
/// <p>The task ARN to modify.</p>
pub fn set_task_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_task_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
/// <p>For more information, see the following topics in the in the <i>Amazon Web Services Systems Manager User Guide</i>:</p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions">Using service-linked roles for Systems Manager</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role">Should I use a service-linked role or a custom service role to run maintenance window tasks? </a> </p> </li>
/// </ul>
pub fn service_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.service_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run <code>RegisterTaskWithMaintenanceWindow</code>.</p>
/// <p>For more information, see the following topics in the in the <i>Amazon Web Services Systems Manager User Guide</i>:</p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions">Using service-linked roles for Systems Manager</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role">Should I use a service-linked role or a custom service role to run maintenance window tasks? </a> </p> </li>
/// </ul>
pub fn set_service_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_service_role_arn(input);
self
}
/// Adds a key-value pair to `TaskParameters`.
///
/// To override the contents of this collection use [`set_task_parameters`](Self::set_task_parameters).
///
/// <p>The parameters to modify.</p> <note>
/// <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <code>MaintenanceWindowTaskInvocationParameters</code>.</p>
/// </note>
/// <p>The map has the following format:</p>
/// <p>Key: string, between 1 and 255 characters</p>
/// <p>Value: an array of strings, each string is between 1 and 255 characters</p>
pub fn task_parameters(
mut self,
k: impl Into<std::string::String>,
v: crate::types::MaintenanceWindowTaskParameterValueExpression,
) -> Self {
self.inner = self.inner.task_parameters(k.into(), v);
self
}
/// <p>The parameters to modify.</p> <note>
/// <p> <code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <code>MaintenanceWindowTaskInvocationParameters</code>.</p>
/// </note>
/// <p>The map has the following format:</p>
/// <p>Key: string, between 1 and 255 characters</p>
/// <p>Value: an array of strings, each string is between 1 and 255 characters</p>
pub fn set_task_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<
std::string::String,
crate::types::MaintenanceWindowTaskParameterValueExpression,
>,
>,
) -> Self {
self.inner = self.inner.set_task_parameters(input);
self
}
/// <p>The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.</p> <important>
/// <p>When you update a maintenance window task that has options specified in <code>TaskInvocationParameters</code>, you must provide again all the <code>TaskInvocationParameters</code> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <code>TaskInvocationParameters</code> values for <code>Comment</code>, <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p>
/// </important>
pub fn task_invocation_parameters(
mut self,
input: crate::types::MaintenanceWindowTaskInvocationParameters,
) -> Self {
self.inner = self.inner.task_invocation_parameters(input);
self
}
/// <p>The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.</p> <important>
/// <p>When you update a maintenance window task that has options specified in <code>TaskInvocationParameters</code>, you must provide again all the <code>TaskInvocationParameters</code> values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified <code>TaskInvocationParameters</code> values for <code>Comment</code>, <code>NotificationConfig</code>, and <code>OutputS3BucketName</code>. If you update the maintenance window task and specify only a different <code>OutputS3BucketName</code> value, the values for <code>Comment</code> and <code>NotificationConfig</code> are removed.</p>
/// </important>
pub fn set_task_invocation_parameters(
mut self,
input: std::option::Option<crate::types::MaintenanceWindowTaskInvocationParameters>,
) -> Self {
self.inner = self.inner.set_task_invocation_parameters(input);
self
}
/// <p>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</p>
pub fn priority(mut self, input: i32) -> Self {
self.inner = self.inner.priority(input);
self
}
/// <p>The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.</p>
pub fn set_priority(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_priority(input);
self
}
/// <p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task, in parallel.</p> <note>
/// <p>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</p>
/// <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p>
/// </note>
pub fn max_concurrency(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.max_concurrency(input.into());
self
}
/// <p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task, in parallel.</p> <note>
/// <p>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</p>
/// <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p>
/// </note>
pub fn set_max_concurrency(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_max_concurrency(input);
self
}
/// <p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled.</p> <note>
/// <p>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</p>
/// <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p>
/// </note>
pub fn max_errors(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.max_errors(input.into());
self
}
/// <p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled.</p> <note>
/// <p>Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html">targetless task</a> You must provide a value in all other cases.</p>
/// <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p>
/// </note>
pub fn set_max_errors(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_max_errors(input);
self
}
/// <p>The new logging location in Amazon S3 to specify.</p> <note>
/// <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <code>MaintenanceWindowTaskInvocationParameters</code>.</p>
/// </note>
pub fn logging_info(mut self, input: crate::types::LoggingInfo) -> Self {
self.inner = self.inner.logging_info(input);
self
}
/// <p>The new logging location in Amazon S3 to specify.</p> <note>
/// <p> <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the <code>OutputS3BucketName</code> and <code>OutputS3KeyPrefix</code> options in the <code>TaskInvocationParameters</code> structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see <code>MaintenanceWindowTaskInvocationParameters</code>.</p>
/// </note>
pub fn set_logging_info(
mut self,
input: std::option::Option<crate::types::LoggingInfo>,
) -> Self {
self.inner = self.inner.set_logging_info(input);
self
}
/// <p>The new task name to specify.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The new task name to specify.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The new task description to specify.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>The new task description to specify.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>If True, then all fields that are required by the <code>RegisterTaskWithMaintenanceWindow</code> operation are also required for this API request. Optional fields that aren't specified are set to null.</p>
pub fn replace(mut self, input: bool) -> Self {
self.inner = self.inner.replace(input);
self
}
/// <p>If True, then all fields that are required by the <code>RegisterTaskWithMaintenanceWindow</code> operation are also required for this API request. Optional fields that aren't specified are set to null.</p>
pub fn set_replace(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_replace(input);
self
}
/// <p>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p>
/// <ul>
/// <li> <p> <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running continue. The default value.</p> </li>
/// <li> <p> <code>CANCEL_TASK</code>:</p>
/// <ul>
/// <li> <p>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</p> </li>
/// <li> <p>For Run Command tasks: When the cutoff time is reached, the system sends a <code>CancelCommand</code> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</p> </li>
/// </ul> <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p> </li>
/// </ul>
pub fn cutoff_behavior(
mut self,
input: crate::types::MaintenanceWindowTaskCutoffBehavior,
) -> Self {
self.inner = self.inner.cutoff_behavior(input);
self
}
/// <p>Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. </p>
/// <ul>
/// <li> <p> <code>CONTINUE_TASK</code>: When the cutoff time is reached, any tasks that are running continue. The default value.</p> </li>
/// <li> <p> <code>CANCEL_TASK</code>:</p>
/// <ul>
/// <li> <p>For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.</p> </li>
/// <li> <p>For Run Command tasks: When the cutoff time is reached, the system sends a <code>CancelCommand</code> operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.</p> </li>
/// </ul> <p>The status for tasks that are not completed is <code>TIMED_OUT</code>.</p> </li>
/// </ul>
pub fn set_cutoff_behavior(
mut self,
input: std::option::Option<crate::types::MaintenanceWindowTaskCutoffBehavior>,
) -> Self {
self.inner = self.inner.set_cutoff_behavior(input);
self
}
/// <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
pub fn alarm_configuration(mut self, input: crate::types::AlarmConfiguration) -> Self {
self.inner = self.inner.alarm_configuration(input);
self
}
/// <p>The CloudWatch alarm you want to apply to your maintenance window task.</p>
pub fn set_alarm_configuration(
mut self,
input: std::option::Option<crate::types::AlarmConfiguration>,
) -> Self {
self.inner = self.inner.set_alarm_configuration(input);
self
}
}