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 CreateMaintenanceWindow operation. Creates a new maintenance window.

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateMaintenanceWindowRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The CreateMaintenanceWindowRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllowUnassociatedTargets System.Boolean

Gets and sets the property AllowUnassociatedTargets.

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

Public Property ClientToken System.String

Gets and sets the property ClientToken.

User-provided idempotency token.

Public Property Cutoff System.Int32

Gets and sets the property Cutoff.

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

Public Property Description System.String

Gets and sets the property Description.

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

Public Property Duration System.Int32

Gets and sets the property Duration.

The duration of the maintenance window in hours.

Public Property EndDate System.String

Gets and sets the property EndDate.

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

Public Property Name System.String

Gets and sets the property Name.

The name of the maintenance window.

Public Property Schedule System.String

Gets and sets the property Schedule.

The schedule of the maintenance window in the form of a cron or rate expression.

Public Property ScheduleOffset System.Int32

Gets and sets the property ScheduleOffset.

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

Public Property ScheduleTimezone System.String

Gets and sets the property ScheduleTimezone.

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Public Property StartDate System.String

Gets and sets the property StartDate.

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

Public Property Tags System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Tag>

Gets and sets the property Tags.

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

  • Key=TaskType,Value=AgentUpdate

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource operation.

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