Struct aws_sdk_ssm::input::UpdateMaintenanceWindowTaskInput

#[non_exhaustive]
pub struct UpdateMaintenanceWindowTaskInput {

    pub window_id: Option<String>,
    pub window_task_id: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub task_arn: Option<String>,
    pub service_role_arn: Option<String>,
    pub task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>,
    pub task_invocation_parameters: Option<MaintenanceWindowTaskInvocationParameters>,
    pub priority: Option<i32>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub logging_info: Option<LoggingInfo>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub replace: Option<bool>,
    pub cutoff_behavior: Option<MaintenanceWindowTaskCutoffBehavior>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

window_id: Option<String>

The maintenance window ID that contains the task to modify.

window_task_id: Option<String>

The task ID to modify.

targets: 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.

task_arn: Option<String>

The task ARN to modify.

service_role_arn: 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 your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:

• Using service-linked roles for Systems Manager

• Should I use a service-linked role or a custom service role to run maintenance window tasks?

task_parameters: 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

task_invocation_parameters: 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.

priority: 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.

max_concurrency: 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.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

max_errors: Option<String>

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

logging_info: 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.

name: Option<String>

The new task name to specify.

description: Option<String>

The new task description to specify.

replace: 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.

cutoff_behavior: 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.

Implementations

impl UpdateMaintenanceWindowTaskInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateMaintenanceWindowTask, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<UpdateMaintenanceWindowTask>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateMaintenanceWindowTaskInput

impl UpdateMaintenanceWindowTaskInput

pub fn window_id(&self) -> Option<&str>

The maintenance window ID that contains the task to modify.

pub fn window_task_id(&self) -> Option<&str>

The task ID to modify.

pub fn targets(&self) -> Option<&[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.

pub fn task_arn(&self) -> Option<&str>

The task ARN to modify.

pub fn service_role_arn(&self) -> Option<&str>

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 RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:

• Using service-linked roles for Systems Manager

• Should I use a service-linked role or a custom service role to run maintenance window tasks?

pub fn 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

pub fn 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.

pub fn 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.

pub fn max_concurrency(&self) -> Option<&str>

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn max_errors(&self) -> Option<&str>

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

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, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn 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.

pub fn name(&self) -> Option<&str>

The new task name to specify.

pub fn description(&self) -> Option<&str>

The new task description to specify.

pub fn 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.

pub fn 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.

Trait Implementations

impl Clone for UpdateMaintenanceWindowTaskInput

fn clone(&self) -> UpdateMaintenanceWindowTaskInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateMaintenanceWindowTaskInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<UpdateMaintenanceWindowTaskInput> for UpdateMaintenanceWindowTaskInput

fn eq(&self, other: &UpdateMaintenanceWindowTaskInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UpdateMaintenanceWindowTaskInput) -> bool

This method tests for !=.

impl StructuralPartialEq for UpdateMaintenanceWindowTaskInput