Struct aws_sdk_ssm::client::fluent_builders::RegisterTaskWithMaintenanceWindow

pub struct RegisterTaskWithMaintenanceWindow { /* private fields */ }

Fluent builder constructing a request to RegisterTaskWithMaintenanceWindow.

Adds a new task to a maintenance window.

Implementations

impl RegisterTaskWithMaintenanceWindow

pub async fn send(
    self
) -> Result<RegisterTaskWithMaintenanceWindowOutput, SdkError<RegisterTaskWithMaintenanceWindowError>>

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.

pub fn window_id(self, input: impl Into<String>) -> Self

The ID of the maintenance window the task should be added to.

pub fn set_window_id(self, input: Option<String>) -> Self

The ID of the maintenance window the task should be added to.

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 maintenance window targets).

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.

Specify managed nodes using the following format:

Key=InstanceIds,Values= ,

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values= ,

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

The targets (either managed nodes or maintenance window targets).

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.

Specify managed nodes using the following format:

Key=InstanceIds,Values= ,

Specify maintenance window targets using the following format:

Key=WindowTargetIds,Values= ,

pub fn task_arn(self, input: impl Into<String>) -> Self

The ARN of the task to run.

pub fn set_task_arn(self, input: Option<String>) -> Self

The ARN of the task to run.

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 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 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 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_type(self, input: MaintenanceWindowTaskType) -> Self

The type of task being registered.

pub fn set_task_type(self, input: Option<MaintenanceWindowTaskType>) -> Self

The type of task being registered.

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 that should be passed to the task when it is run.

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.

pub fn set_task_parameters(
    self,
    input: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
) -> Self

The parameters that should be passed to the task when it is run.

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.

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.

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.

pub fn priority(self, input: i32) -> Self

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

pub fn set_priority(self, input: Option<i32>) -> Self

The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

pub fn max_concurrency(self, input: impl Into<String>) -> Self

The maximum number of targets this task can be run for, 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.

pub fn set_max_concurrency(self, input: Option<String>) -> Self

The maximum number of targets this task can be run for, 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.

pub fn max_errors(self, input: impl Into<String>) -> Self

The maximum number of errors allowed before this 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.

pub fn set_max_errors(self, input: Option<String>) -> Self

The maximum number of errors allowed before this 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.

pub fn logging_info(self, input: LoggingInfo) -> Self

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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 set_logging_info(self, input: Option<LoggingInfo>) -> Self

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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, input: impl Into<String>) -> Self

An optional name for the task.

pub fn set_name(self, input: Option<String>) -> Self

An optional name for the task.

pub fn description(self, input: impl Into<String>) -> Self

An optional description for the task.

pub fn set_description(self, input: Option<String>) -> Self

An optional description for the task.

pub fn client_token(self, input: impl Into<String>) -> Self

User-provided idempotency token.

pub fn set_client_token(self, input: Option<String>) -> Self

User-provided idempotency token.

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.

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.

Trait Implementations

impl Clone for RegisterTaskWithMaintenanceWindow

fn clone(&self) -> RegisterTaskWithMaintenanceWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterTaskWithMaintenanceWindow

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

Formats the value using the given formatter.