Class CfnMaintenanceWindow
The AWS::SSM::MaintenanceWindow
resource represents general information about a maintenance window for AWS Systems Manager .
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMaintenanceWindow : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnMaintenanceWindow
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Maintenance windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS), updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks.
For more information, see Systems Manager Maintenance Windows in the AWS Systems Manager User Guide and CreateMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindow
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var cfnMaintenanceWindow = new CfnMaintenanceWindow(this, "MyCfnMaintenanceWindow", new CfnMaintenanceWindowProps {
AllowUnassociatedTargets = false,
Cutoff = 123,
Duration = 123,
Name = "name",
Schedule = "schedule",
// the properties below are optional
Description = "description",
EndDate = "endDate",
ScheduleOffset = 123,
ScheduleTimezone = "scheduleTimezone",
StartDate = "startDate",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnMaintenanceWindow(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMaintenanceWindow(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnMaintenanceWindow(Construct, String, ICfnMaintenanceWindowProps) |
Properties
AllowUnassociatedTargets | Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Cutoff | The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution. |
Description | A description of the maintenance window. |
Duration | The duration of the maintenance window in hours. |
EndDate | The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. |
Name | The name of the maintenance window. |
Schedule | The schedule of the maintenance window in the form of a cron or rate expression. |
ScheduleOffset | The number of days to wait to run a maintenance window after the scheduled cron expression date and time. |
ScheduleTimezone | The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. |
StartDate | The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMaintenanceWindow(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMaintenanceWindow(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMaintenanceWindow(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMaintenanceWindow(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnMaintenanceWindow(Construct, String, ICfnMaintenanceWindowProps)
public CfnMaintenanceWindow(Construct scope, string id, ICfnMaintenanceWindowProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMaintenanceWindowProps
Resource properties.
Properties
AllowUnassociatedTargets
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
public virtual object AllowUnassociatedTargets { get; set; }
Property Value
System.Object
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Cutoff
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
public virtual double Cutoff { get; set; }
Property Value
System.Double
Description
A description of the maintenance window.
public virtual string Description { get; set; }
Property Value
System.String
Duration
The duration of the maintenance window in hours.
public virtual double Duration { get; set; }
Property Value
System.Double
EndDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
public virtual string EndDate { get; set; }
Property Value
System.String
Name
The name of the maintenance window.
public virtual string Name { get; set; }
Property Value
System.String
Schedule
The schedule of the maintenance window in the form of a cron or rate expression.
public virtual string Schedule { get; set; }
Property Value
System.String
ScheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
public virtual Nullable<double> ScheduleOffset { get; set; }
Property Value
System.Nullable<System.Double>
ScheduleTimezone
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
public virtual string ScheduleTimezone { get; set; }
Property Value
System.String
StartDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
public virtual string StartDate { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>