Struct aws_sdk_ssm::model::MaintenanceWindowTask [−][src]
#[non_exhaustive]pub struct MaintenanceWindowTask {Show 14 fields
pub window_id: Option<String>,
pub window_task_id: Option<String>,
pub task_arn: Option<String>,
pub type: Option<MaintenanceWindowTaskType>,
pub targets: Option<Vec<Target>>,
pub task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>,
pub priority: i32,
pub logging_info: Option<LoggingInfo>,
pub service_role_arn: Option<String>,
pub max_concurrency: Option<String>,
pub max_errors: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub cutoff_behavior: Option<MaintenanceWindowTaskCutoffBehavior>,
}
Expand description
Information about a task defined for a maintenance window.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.window_id: Option<String>
The ID of the maintenance window where the task is registered.
window_task_id: Option<String>
The task ID.
task_arn: Option<String>
The resource that the task uses during execution. For RUN_COMMAND
and
AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems Manager (SSM document) name or
ARN. For LAMBDA
tasks, it's the function name or ARN. For
STEP_FUNCTIONS
tasks, it's the state machine ARN.
type: Option<MaintenanceWindowTaskType>
The type of task.
targets: Option<Vec<Target>>
The targets (either instances or tags). Instances are specified using
Key=instanceids,Values=
. Tags are specified
using Key=
.
task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
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.
priority: i32
The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
logging_info: Option<LoggingInfo>
Information about an S3 bucket to write task-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.
service_role_arn: Option<String>
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
max_concurrency: Option<String>
The maximum number of targets this task can be run for, in parallel.
max_errors: Option<String>
The maximum number of errors allowed before this task stops being scheduled.
name: Option<String>
The task name.
description: Option<String>
A description of the task.
cutoff_behavior: Option<MaintenanceWindowTaskCutoffBehavior>
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
Implementations
The ID of the maintenance window where the task is registered.
The task ID.
The resource that the task uses during execution. For RUN_COMMAND
and
AUTOMATION
task types, TaskArn
is the Amazon Web Services Systems Manager (SSM document) name or
ARN. For LAMBDA
tasks, it's the function name or ARN. For
STEP_FUNCTIONS
tasks, it's the state machine ARN.
The type of task.
The targets (either instances or tags). Instances are specified using
Key=instanceids,Values=
. Tags are specified
using Key=
.
pub fn task_parameters(
&self
) -> Option<&HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
pub fn task_parameters(
&self
) -> Option<&HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
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.
The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
Information about an S3 bucket to write task-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.
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
The maximum number of targets this task can be run for, in parallel.
The maximum number of errors allowed before this task stops being scheduled.
A description of the task.
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
Creates a new builder-style object to manufacture MaintenanceWindowTask
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for MaintenanceWindowTask
impl Send for MaintenanceWindowTask
impl Sync for MaintenanceWindowTask
impl Unpin for MaintenanceWindowTask
impl UnwindSafe for MaintenanceWindowTask
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more