AWS::SSM::MaintenanceWindow - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::SSM::MaintenanceWindow

AWS::SSM::MaintenanceWindow 资源表示有关 AWS Systems Manager 的维护时段的常规信息。借助维护时段,您可以制定计划,规定何时对实例执行具有潜在破坏性的操作,比如修补操作系统 (OS)、更新驱动程序或安装软件。每个维护时段都有一个计划、一段持续时间、一组注册目标和一组注册任务。

有关更多信息,请参阅 AWS Systems Manager 用户指南 中的 Systems Manager 维护时段AWS Systems Manager API 参考 中的 CreateMaintenanceWindow

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::SSM::MaintenanceWindow", "Properties" : { "AllowUnassociatedTargets" : Boolean, "Cutoff" : Integer, "Description" : String, "Duration" : Integer, "EndDate" : String, "Name" : String, "Schedule" : String, "ScheduleOffset" : Integer, "ScheduleTimezone" : String, "StartDate" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::SSM::MaintenanceWindow Properties: AllowUnassociatedTargets: Boolean Cutoff: Integer Description: String Duration: Integer EndDate: String Name: String Schedule: String ScheduleOffset: Integer ScheduleTimezone: String StartDate: String Tags: - Tag

属性

AllowUnassociatedTargets

启用维护时段任务以在托管实例上运行,即使您还没有将这些实例注册为目标也是如此。如果启用了此选项,则您必须在将任务注册到维护时段时指定已注销实例(按实例 ID)。

必需:是

类型:布尔值

Update requires: No interruption

Cutoff

维护时段结束前的小时数,此时,Systems Manager 停止为新任务安排执行计划。

必需:是

类型:整数

最低0

最高23

Update requires: No interruption

Description

维护时段的描述。

必需:否

类型:字符串

最低1

最高128

Update requires: No interruption

Duration

维护时段的持续时间(以小时为单位)。

必需:是

类型:整数

最低1

最高24

Update requires: No interruption

EndDate

维护时段计划变为不活动状态的日期和时间,采用 ISO-8601 扩展格式。

必需:否

类型:字符串

Update requires: No interruption

Name

维护时段的名称。

必需:是

类型:字符串

最低3

最高128

模式^[a-zA-Z0-9_\-.]{3,128}$

Update requires: No interruption

Schedule

采用 cron 或 rate 表达式形式的维护时段的计划。

必需:是

类型:字符串

最低1

最高256

Update requires: No interruption

ScheduleOffset

在计划的 CRON 表达式日期和时间之后等待运行维护时段的天数。

必需:否

类型:整数

最低1

最高: 6

Update requires: No interruption

ScheduleTimezone

计划的维护时段执行基于的时区,采用 Internet 分配的编号机构 (IANA) 格式。

必需:否

类型:字符串

Update requires: No interruption

StartDate

维护时段计划变为活动状态的日期和时间,采用 ISO-8601 扩展格式。通过使用 StartDate,您可以将维护时段的激活时间推迟到指定的将来日期。

必需:否

类型:字符串

Update requires: No interruption

Tags

以任意标签集(键/值对)的形式分配给资源的可选元数据。标签可让您按各种标准(如用途、所有者或环境)对资源进行分类。例如,您可能需要标记维护时段来标识它将运行的任务的类型、目标类型和它将运行于的环境。

必需:否

类型Tag 的列表

最高1000

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回维护时段 ID,例如 mw-abcde1234567890yz

For more information about using the Ref function, see Ref.

示例

创建不允许未注册的目标的维护时段

以下示例创建一个 Systems Manager 维护时段,该时段每周日美国东部时间凌晨 04:00 开始,持续两小时,截止时间为一小时。维护时段还不允许已注销目标。

JSON

{ "Resources": { "MaintenanceWindow": { "Type": "AWS::SSM::MaintenanceWindow", "Properties": { "AllowUnassociatedTargets": false, "Cutoff": 1, "Description": "Maintenance Window to update SSM Agent", "Duration": 2, "Name": "UpdateSSMAgentMaintenanceWindow", "Schedule": "cron(0 4 ? * SUN *)", "ScheduleTimezone": "US/Eastern" } } } }

YAML

--- Resources: MaintenanceWindow: Type: AWS::SSM::MaintenanceWindow Properties: AllowUnassociatedTargets: false Cutoff: 1 Description: Maintenance Window to update SSM Agent Duration: 2 Name: UpdateSSMAgentMaintenanceWindow Schedule: cron(0 4 ? * SUN *) ScheduleTimezone: US/Eastern

另请参阅