Show / Hide Table of Contents

Class CfnMaintenanceWindowMixinProps

Properties for CfnMaintenanceWindowPropsMixin.

Inheritance
object
CfnMaintenanceWindowMixinProps
Implements
ICfnMaintenanceWindowMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.SSM
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnMaintenanceWindowMixinProps : ICfnMaintenanceWindowMixinProps
Syntax (vb)
Public Class CfnMaintenanceWindowMixinProps Implements ICfnMaintenanceWindowMixinProps
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.CfnPropertyMixins.AWS.SSM;

             var cfnMaintenanceWindowMixinProps = new CfnMaintenanceWindowMixinProps {
                 AllowUnassociatedTargets = false,
                 Cutoff = 123,
                 Description = "description",
                 Duration = 123,
                 EndDate = "endDate",
                 Name = "name",
                 Schedule = "schedule",
                 ScheduleOffset = 123,
                 ScheduleTimezone = "scheduleTimezone",
                 StartDate = "startDate",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnMaintenanceWindowMixinProps()

Properties for CfnMaintenanceWindowPropsMixin.

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

Constructors

CfnMaintenanceWindowMixinProps()

Properties for CfnMaintenanceWindowPropsMixin.

public CfnMaintenanceWindowMixinProps()
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.CfnPropertyMixins.AWS.SSM;

             var cfnMaintenanceWindowMixinProps = new CfnMaintenanceWindowMixinProps {
                 AllowUnassociatedTargets = false,
                 Cutoff = 123,
                 Description = "description",
                 Duration = 123,
                 EndDate = "endDate",
                 Name = "name",
                 Schedule = "schedule",
                 ScheduleOffset = 123,
                 ScheduleTimezone = "scheduleTimezone",
                 StartDate = "startDate",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AllowUnassociatedTargets

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

public object? AllowUnassociatedTargets { get; set; }
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.

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

Type union: either bool or IResolvable

Cutoff

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

public double? Cutoff { get; set; }
Property Value

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.

public string? Description { get; set; }
Property Value

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.

public double? Duration { get; set; }
Property Value

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.

public string? EndDate { get; set; }
Property Value

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.

public string? Name { get; set; }
Property Value

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.

public string? Schedule { get; set; }
Property Value

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.

public double? ScheduleOffset { get; set; }
Property Value

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.

public string? ScheduleTimezone { get; set; }
Property Value

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.

public string? StartDate { get; set; }
Property Value

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

Tags

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

public ICfnTag[]? Tags { get; set; }
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.

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

Implements

ICfnMaintenanceWindowMixinProps
Back to top Generated by DocFX