CfnMaintenanceWindowProps

class aws_cdk.aws_ssm.CfnMaintenanceWindowProps(*, allow_unassociated_targets, cutoff, duration, name, schedule, description=None, end_date=None, schedule_offset=None, schedule_timezone=None, start_date=None, tags=None)

Bases: object

Properties for defining a CfnMaintenanceWindow.

Parameters
  • allow_unassociated_targets (Union[bool, IResolvable]) – Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

  • cutoff (Union[int, float]) – The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

  • duration (Union[int, float]) – The duration of the maintenance window in hours.

  • name (str) – The name of the maintenance window.

  • schedule (str) – The schedule of the maintenance window in the form of a cron or rate expression.

  • description (Optional[str]) – A description of the maintenance window.

  • end_date (Optional[str]) – The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

  • schedule_offset (Union[int, float, None]) – The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

  • schedule_timezone (Optional[str]) – The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

  • start_date (Optional[str]) – The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. StartDate allows you to delay activation of the Maintenance Window until the specified future date.

  • tags (Optional[Sequence[CfnTag]]) – Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). 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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

cfn_maintenance_window_props = ssm.CfnMaintenanceWindowProps(
    allow_unassociated_targets=False,
    cutoff=123,
    duration=123,
    name="name",
    schedule="schedule",

    # the properties below are optional
    description="description",
    end_date="endDate",
    schedule_offset=123,
    schedule_timezone="scheduleTimezone",
    start_date="startDate",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

allow_unassociated_targets

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

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

Return type

Union[bool, IResolvable]

cutoff

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

Link

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

Return type

Union[int, float]

description

A description of the maintenance window.

Link

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

Return type

Optional[str]

duration

The duration of the maintenance window in hours.

Link

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

Return type

Union[int, float]

end_date

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

Link

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

Return type

Optional[str]

name

The name of the maintenance window.

Link

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

Return type

str

schedule

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

Link

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

Return type

str

schedule_offset

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

Link

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

Return type

Union[int, float, None]

schedule_timezone

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

Link

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

Return type

Optional[str]

start_date

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

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

Return type

Optional[str]

tags

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

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

Return type

Optional[List[CfnTag]]