Interface ICfnMaintenanceWindowProps

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties for defining a CfnMaintenanceWindow.

public interface ICfnMaintenanceWindowProps

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 cfnMaintenanceWindowProps = 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"
                 } }
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html

ExampleMetadata: fixture=_generated

Properties

AllowUnassociatedTargets

Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

object AllowUnassociatedTargets { get; }

Property Value

object

Remarks

If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets

Cutoff

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

double Cutoff { get; }

Property Value

double

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff

Description

A description of the maintenance window.

string? Description { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description

Duration

The duration of the maintenance window in hours.

double Duration { get; }

Property Value

double

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration

EndDate

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

string? EndDate { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate

Name

The name of the maintenance window.

string Name { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name

Schedule

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

string Schedule { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule

ScheduleOffset

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

double? ScheduleOffset { get; }

Property Value

double?

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset

ScheduleTimezone

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

string? ScheduleTimezone { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone

StartDate

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

string? StartDate { get; }

Property Value

string

Remarks

StartDate allows you to delay activation of the Maintenance Window until the specified future date.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate

Tags

Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags