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.

Container for the parameters to the RegisterTaskWithMaintenanceWindow operation. Adds a new task to a Maintenance Window.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.RegisterTaskWithMaintenanceWindowRequest

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

Syntax

C#
public class RegisterTaskWithMaintenanceWindowRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The RegisterTaskWithMaintenanceWindowRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

User-provided idempotency token.

Public Property Description System.String

Gets and sets the property Description.

An optional description for the task.

Public Property LoggingInfo Amazon.SimpleSystemsManagement.Model.LoggingInfo

Gets and sets the property LoggingInfo.

A structure containing information about an Amazon S3 bucket to write instance-level logs to.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how 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.

Public Property MaxErrors System.String

Gets and sets the property MaxErrors.

The maximum number of errors allowed before this task stops being scheduled.

Public Property Name System.String

Gets and sets the property Name.

An optional name for the task.

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 in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

The role to assume when running the Maintenance Window task.

If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run RegisterTaskWithMaintenanceWindow without specifying a service role ARN.

For more information, see Service-Linked Role Permissions for Systems Manager and Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? in the AWS Systems Manager User Guide.

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

Gets and sets the property Targets.

The targets (either instances or Maintenance Window targets).

Specify instances using the following format:

Key=InstanceIds,Values=,

Specify Maintenance Window targets using the following format:

Key=,Values=,

Public Property TaskArn System.String

Gets and sets the property TaskArn.

The ARN of the task to execute

Public Property TaskInvocationParameters Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskInvocationParameters

Gets and sets the property TaskInvocationParameters.

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

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 executed.

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 TaskType Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType

Gets and sets the property TaskType.

The type of task being registered.

Public Property WindowId System.String

Gets and sets the property WindowId.

The ID of the Maintenance Window the task should be added to.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms