AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Information about a task defined for a maintenance window.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTask

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C# 
public class MaintenanceWindowTask

The MaintenanceWindowTask type exposes the following members

Constructors

NameDescription
Public Method MaintenanceWindowTask()

Properties

NameTypeDescription
Public Property AlarmConfiguration Amazon.SimpleSystemsManagement.Model.AlarmConfiguration

Gets and sets the property AlarmConfiguration.

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

Public Property CutoffBehavior Amazon.SimpleSystemsManagement.MaintenanceWindowTaskCutoffBehavior

Gets and sets the property CutoffBehavior.

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

Public Property Description System.String

Gets and sets the property Description.

A description of the task.

Public Property LoggingInfo Amazon.SimpleSystemsManagement.Model.LoggingInfo

Gets and sets the property 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.

Public Property MaxConcurrency System.String

Gets and sets the property MaxConcurrency.

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.

Public Property MaxErrors System.String

Gets and sets the property MaxErrors.

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.

Public Property Name System.String

Gets and sets the property Name.

The task name.

Public Property Priority System.Int32

Gets and sets the property Priority.

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.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

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.

Public Property Targets System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Target>

Gets and sets the property Targets.

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

Public Property TaskArn System.String

Gets and sets the property TaskArn.

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.

Public Property TaskParameters System.Collections.Generic.Dictionary<System.String, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression>

Gets and sets the property TaskParameters.

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.

Public Property Type Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType

Gets and sets the property Type.

The type of task.

Public Property WindowId System.String

Gets and sets the property WindowId.

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

Public Property WindowTaskId System.String

Gets and sets the property WindowTaskId.

The task ID.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5