pub struct RegisterTaskWithMaintenanceWindow { /* private fields */ }
Expand description
Fluent builder constructing a request to RegisterTaskWithMaintenanceWindow
.
Adds a new task to a maintenance window.
Implementations
sourceimpl RegisterTaskWithMaintenanceWindow
impl RegisterTaskWithMaintenanceWindow
sourcepub async fn send(
self
) -> Result<RegisterTaskWithMaintenanceWindowOutput, SdkError<RegisterTaskWithMaintenanceWindowError>>
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.
sourcepub fn window_id(self, input: impl Into<String>) -> Self
pub fn window_id(self, input: impl Into<String>) -> Self
The ID of the maintenance window the task should be added to.
sourcepub fn set_window_id(self, input: Option<String>) -> Self
pub fn set_window_id(self, input: Option<String>) -> Self
The ID of the maintenance window the task should be added to.
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 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=
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 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=
sourcepub fn set_task_arn(self, input: Option<String>) -> Self
pub fn set_task_arn(self, input: Option<String>) -> Self
The ARN of the task to run.
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 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:
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 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:
sourcepub fn task_type(self, input: MaintenanceWindowTaskType) -> Self
pub fn task_type(self, input: MaintenanceWindowTaskType) -> Self
The type of task being registered.
sourcepub fn set_task_type(self, input: Option<MaintenanceWindowTaskType>) -> Self
pub fn set_task_type(self, input: Option<MaintenanceWindowTaskType>) -> Self
The type of task being registered.
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 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
.
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 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
.
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.
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.
sourcepub fn priority(self, input: i32) -> Self
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.
sourcepub fn set_priority(self, input: Option<i32>) -> Self
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.
sourcepub fn max_concurrency(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_max_concurrency(self, input: Option<String>) -> Self
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.
sourcepub fn max_errors(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_max_errors(self, input: Option<String>) -> Self
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.
sourcepub fn logging_info(self, input: LoggingInfo) -> Self
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
.
sourcepub fn set_logging_info(self, input: Option<LoggingInfo>) -> Self
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
.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional description for the task.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional description for the task.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
User-provided idempotency token.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
User-provided idempotency token.
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
. -
Trait Implementations
sourceimpl Clone for RegisterTaskWithMaintenanceWindow
impl Clone for RegisterTaskWithMaintenanceWindow
sourcefn clone(&self) -> RegisterTaskWithMaintenanceWindow
fn clone(&self) -> RegisterTaskWithMaintenanceWindow
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for RegisterTaskWithMaintenanceWindow
impl Send for RegisterTaskWithMaintenanceWindow
impl Sync for RegisterTaskWithMaintenanceWindow
impl Unpin for RegisterTaskWithMaintenanceWindow
impl !UnwindSafe for RegisterTaskWithMaintenanceWindow
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more