Struct aws_sdk_ssm::types::MaintenanceWindowTask

#[non_exhaustive]
pub struct MaintenanceWindowTask {

    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>,
    pub alarm_configuration: Option<AlarmConfiguration>,
}

Information about a task defined for a maintenance window.

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 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 managed nodes or tags). Managed nodes are specified using Key=instanceids,Values= , . Tags are specified using Key= ,Values= .

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.

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.

max_errors: Option<String>

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.

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.

alarm_configuration: Option<AlarmConfiguration>

The details for the CloudWatch alarm applied to your maintenance window task.

Implementations

impl MaintenanceWindowTask

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

The ID of the maintenance window where the task is registered.

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

The task ID.

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

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.

pub fn type(&self) -> Option<&MaintenanceWindowTaskType>

The type of task.

pub fn targets(&self) -> &[Target]

The targets (either managed nodes or tags). Managed nodes are specified using Key=instanceids,Values= , . Tags are specified using Key= ,Values= .

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

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.

pub fn priority(&self) -> 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.

pub fn logging_info(&self) -> 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.

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

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.

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

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) -> Option<&str>

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 name(&self) -> Option<&str>

The task name.

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

A description of the task.

pub fn cutoff_behavior(&self) -> Option<&MaintenanceWindowTaskCutoffBehavior>

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The details for the CloudWatch alarm applied to your maintenance window task.

impl MaintenanceWindowTask

pub fn builder() -> MaintenanceWindowTaskBuilder

Creates a new builder-style object to manufacture MaintenanceWindowTask.

Trait Implementations

impl Clone for MaintenanceWindowTask

fn clone(&self) -> MaintenanceWindowTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaintenanceWindowTask

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

Formats the value using the given formatter.

impl PartialEq for MaintenanceWindowTask

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MaintenanceWindowTask