Interface ICfnMaintenanceWindowProps

Properties for defining a CfnMaintenanceWindow.

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMaintenanceWindowProps

Syntax (vb)

Public Interface ICfnMaintenanceWindowProps

Remarks

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

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

Synopsis

Properties

AllowUnassociatedTargets	Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
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	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

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

System.Object

Remarks

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

See: 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

System.Double

Remarks

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

Description

A description of the maintenance window.

virtual string Description { get; }

Property Value

System.String

Remarks

See: 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

System.Double

Remarks

See: 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.

virtual string EndDate { get; }

Property Value

System.String

Remarks

See: 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

System.String

Remarks

See: 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

System.String

Remarks

See: 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.

virtual Nullable<double> ScheduleOffset { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: 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.

virtual string ScheduleTimezone { get; }

Property Value

System.String

Remarks

See: 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.

virtual string StartDate { get; }

Property Value

System.String

Remarks

StartDate allows you to delay activation of the maintenance window until the specified future date.

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