Struct aws_sdk_ssm::operation::update_maintenance_window_task::builders::UpdateMaintenanceWindowTaskFluentBuilder
source · pub struct UpdateMaintenanceWindowTaskFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateMaintenanceWindowTask
.
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
-
TaskARN
. For example, you can change aRUN_COMMAND
task fromAWS-RunPowerShellScript
toAWS-RunShellScript
. -
ServiceRoleArn
-
TaskInvocationParameters
-
Priority
-
MaxConcurrency
-
MaxErrors
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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask
is null, then the corresponding field isn't modified. If you set Replace
to true, then all fields required by the RegisterTaskWithMaintenanceWindow
operation are required for this request. Optional fields that aren't specified are set to null.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters
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 TaskInvocationParameters
values for Comment
, NotificationConfig
, and OutputS3BucketName
. If you update the maintenance window task and specify only a different OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
Implementations§
source§impl UpdateMaintenanceWindowTaskFluentBuilder
impl UpdateMaintenanceWindowTaskFluentBuilder
sourcepub fn as_input(&self) -> &UpdateMaintenanceWindowTaskInputBuilder
pub fn as_input(&self) -> &UpdateMaintenanceWindowTaskInputBuilder
Access the UpdateMaintenanceWindowTask as a reference.
sourcepub async fn send(
self
) -> Result<UpdateMaintenanceWindowTaskOutput, SdkError<UpdateMaintenanceWindowTaskError, HttpResponse>>
pub async fn send( self ) -> Result<UpdateMaintenanceWindowTaskOutput, SdkError<UpdateMaintenanceWindowTaskError, HttpResponse>>
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, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<UpdateMaintenanceWindowTaskOutput, UpdateMaintenanceWindowTaskError, Self>
pub fn customize( self ) -> CustomizableOperation<UpdateMaintenanceWindowTaskOutput, UpdateMaintenanceWindowTaskError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn window_id(self, input: impl Into<String>) -> Self
pub fn window_id(self, input: impl Into<String>) -> Self
The maintenance window ID that contains the task to modify.
sourcepub fn set_window_id(self, input: Option<String>) -> Self
pub fn set_window_id(self, input: Option<String>) -> Self
The maintenance window ID that contains the task to modify.
sourcepub fn get_window_id(&self) -> &Option<String>
pub fn get_window_id(&self) -> &Option<String>
The maintenance window ID that contains the task to modify.
sourcepub fn window_task_id(self, input: impl Into<String>) -> Self
pub fn window_task_id(self, input: impl Into<String>) -> Self
The task ID to modify.
sourcepub fn set_window_task_id(self, input: Option<String>) -> Self
pub fn set_window_task_id(self, input: Option<String>) -> Self
The task ID to modify.
sourcepub fn get_window_task_id(&self) -> &Option<String>
pub fn get_window_task_id(&self) -> &Option<String>
The task ID to modify.
sourcepub fn targets(self, input: Target) -> Self
pub fn targets(self, input: Target) -> Self
Appends an item to Targets
.
To override the contents of this collection use set_targets
.
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2
. Tags are specified using the format Key=tag_name,Values=tag_value
.
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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
sourcepub fn set_targets(self, input: Option<Vec<Target>>) -> Self
pub fn set_targets(self, input: Option<Vec<Target>>) -> Self
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2
. Tags are specified using the format Key=tag_name,Values=tag_value
.
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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
sourcepub fn get_targets(&self) -> &Option<Vec<Target>>
pub fn get_targets(&self) -> &Option<Vec<Target>>
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2
. Tags are specified using the format Key=tag_name,Values=tag_value
.
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 Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
sourcepub fn set_task_arn(self, input: Option<String>) -> Self
pub fn set_task_arn(self, input: Option<String>) -> Self
The task ARN to modify.
sourcepub fn get_task_arn(&self) -> &Option<String>
pub fn get_task_arn(&self) -> &Option<String>
The task ARN to modify.
sourcepub fn service_role_arn(self, input: impl Into<String>) -> Self
pub fn service_role_arn(self, input: impl Into<String>) -> Self
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow
.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.
sourcepub fn set_service_role_arn(self, input: Option<String>) -> Self
pub fn set_service_role_arn(self, input: Option<String>) -> Self
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow
.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.
sourcepub fn get_service_role_arn(&self) -> &Option<String>
pub fn get_service_role_arn(&self) -> &Option<String>
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 a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow
.
However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up maintenance windows in the in the Amazon Web Services Systems Manager User Guide.
sourcepub fn task_parameters(
self,
k: impl Into<String>,
v: MaintenanceWindowTaskParameterValueExpression
) -> Self
pub fn task_parameters( self, k: impl Into<String>, v: MaintenanceWindowTaskParameterValueExpression ) -> Self
Adds a key-value pair to TaskParameters
.
To override the contents of this collection use set_task_parameters
.
The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters
option in the TaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
sourcepub fn set_task_parameters(
self,
input: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
) -> Self
pub fn set_task_parameters( self, input: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>> ) -> Self
The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters
option in the TaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
sourcepub fn get_task_parameters(
&self
) -> &Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
pub fn get_task_parameters( &self ) -> &Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters
option in the TaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
sourcepub fn task_invocation_parameters(
self,
input: MaintenanceWindowTaskInvocationParameters
) -> Self
pub fn task_invocation_parameters( self, input: MaintenanceWindowTaskInvocationParameters ) -> Self
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters
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 TaskInvocationParameters
values for Comment
, NotificationConfig
, and OutputS3BucketName
. If you update the maintenance window task and specify only a different OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
sourcepub fn set_task_invocation_parameters(
self,
input: Option<MaintenanceWindowTaskInvocationParameters>
) -> Self
pub fn set_task_invocation_parameters( self, input: Option<MaintenanceWindowTaskInvocationParameters> ) -> Self
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters
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 TaskInvocationParameters
values for Comment
, NotificationConfig
, and OutputS3BucketName
. If you update the maintenance window task and specify only a different OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
sourcepub fn get_task_invocation_parameters(
&self
) -> &Option<MaintenanceWindowTaskInvocationParameters>
pub fn get_task_invocation_parameters( &self ) -> &Option<MaintenanceWindowTaskInvocationParameters>
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in TaskInvocationParameters
, you must provide again all the TaskInvocationParameters
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 TaskInvocationParameters
values for Comment
, NotificationConfig
, and OutputS3BucketName
. If you update the maintenance window task and specify only a different OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
sourcepub fn max_concurrency(self, input: impl Into<String>) -> Self
pub fn max_concurrency(self, input: impl Into<String>) -> Self
The new MaxConcurrency
value you want to specify. MaxConcurrency
is the number of targets that are allowed to run this task, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn set_max_concurrency(self, input: Option<String>) -> Self
pub fn set_max_concurrency(self, input: Option<String>) -> Self
The new MaxConcurrency
value you want to specify. MaxConcurrency
is the number of targets that are allowed to run this task, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn get_max_concurrency(&self) -> &Option<String>
pub fn get_max_concurrency(&self) -> &Option<String>
The new MaxConcurrency
value you want to specify. MaxConcurrency
is the number of targets that are allowed to run this task, in parallel.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn max_errors(self, input: impl Into<String>) -> Self
pub fn max_errors(self, input: impl Into<String>) -> Self
The new MaxErrors
value to specify. MaxErrors
is the maximum number of errors that are allowed before the task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn set_max_errors(self, input: Option<String>) -> Self
pub fn set_max_errors(self, input: Option<String>) -> Self
The new MaxErrors
value to specify. MaxErrors
is the maximum number of errors that are allowed before the task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn get_max_errors(&self) -> &Option<String>
pub fn get_max_errors(&self) -> &Option<String>
The new MaxErrors
value to specify. MaxErrors
is the maximum number of errors that are allowed before the task stops being scheduled.
Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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 1
. This value doesn't affect the running of your task.
sourcepub fn logging_info(self, input: LoggingInfo) -> Self
pub fn logging_info(self, input: LoggingInfo) -> Self
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
sourcepub fn set_logging_info(self, input: Option<LoggingInfo>) -> Self
pub fn set_logging_info(self, input: Option<LoggingInfo>) -> Self
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
sourcepub fn get_logging_info(&self) -> &Option<LoggingInfo>
pub fn get_logging_info(&self) -> &Option<LoggingInfo>
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName
and OutputS3KeyPrefix
options in the TaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters
.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The new task description to specify.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The new task description to specify.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The new task description to specify.
sourcepub fn replace(self, input: bool) -> Self
pub fn replace(self, input: bool) -> Self
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow
operation are also required for this API request. Optional fields that aren't specified are set to null.
sourcepub fn set_replace(self, input: Option<bool>) -> Self
pub fn set_replace(self, input: Option<bool>) -> Self
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow
operation are also required for this API request. Optional fields that aren't specified are set to null.
sourcepub fn get_replace(&self) -> &Option<bool>
pub fn get_replace(&self) -> &Option<bool>
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow
operation are also required for this API request. Optional fields that aren't specified are set to null.
sourcepub fn cutoff_behavior(self, input: MaintenanceWindowTaskCutoffBehavior) -> Self
pub fn cutoff_behavior(self, input: MaintenanceWindowTaskCutoffBehavior) -> Self
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
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.
-
For Run Command tasks: When the cutoff time is reached, the system sends a
CancelCommand
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.
The status for tasks that are not completed is
TIMED_OUT
. -
sourcepub fn set_cutoff_behavior(
self,
input: Option<MaintenanceWindowTaskCutoffBehavior>
) -> Self
pub fn set_cutoff_behavior( self, input: Option<MaintenanceWindowTaskCutoffBehavior> ) -> Self
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
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.
-
For Run Command tasks: When the cutoff time is reached, the system sends a
CancelCommand
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.
The status for tasks that are not completed is
TIMED_OUT
. -
sourcepub fn get_cutoff_behavior(
&self
) -> &Option<MaintenanceWindowTaskCutoffBehavior>
pub fn get_cutoff_behavior( &self ) -> &Option<MaintenanceWindowTaskCutoffBehavior>
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
-
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value. -
CANCEL_TASK
:-
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.
-
For Run Command tasks: When the cutoff time is reached, the system sends a
CancelCommand
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.
The status for tasks that are not completed is
TIMED_OUT
. -
sourcepub fn alarm_configuration(self, input: AlarmConfiguration) -> Self
pub fn alarm_configuration(self, input: AlarmConfiguration) -> Self
The CloudWatch alarm you want to apply to your maintenance window task.
sourcepub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self
pub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self
The CloudWatch alarm you want to apply to your maintenance window task.
sourcepub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>
pub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>
The CloudWatch alarm you want to apply to your maintenance window task.
Trait Implementations§
source§impl Clone for UpdateMaintenanceWindowTaskFluentBuilder
impl Clone for UpdateMaintenanceWindowTaskFluentBuilder
source§fn clone(&self) -> UpdateMaintenanceWindowTaskFluentBuilder
fn clone(&self) -> UpdateMaintenanceWindowTaskFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateMaintenanceWindowTaskFluentBuilder
impl !RefUnwindSafe for UpdateMaintenanceWindowTaskFluentBuilder
impl Send for UpdateMaintenanceWindowTaskFluentBuilder
impl Sync for UpdateMaintenanceWindowTaskFluentBuilder
impl Unpin for UpdateMaintenanceWindowTaskFluentBuilder
impl !UnwindSafe for UpdateMaintenanceWindowTaskFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more