Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Systems Manager Resource Types Reference » AWS::SSM::MaintenanceWindowTarget

AWS::SSM::MaintenanceWindowTarget

The AWS::SSM::MaintenanceWindowTarget resource registers a target with a Maintenance Window for AWS Systems Manager. For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSM::MaintenanceWindowTarget",
  "Properties" : {
    "OwnerInformation" : String,
    "Description" : String,
    "WindowId" : String,
    "ResourceType" : String,
    "Targets" : [ Targets, ... ],
    "Name" : String
  }
}

YAML

Type: "AWS::SSM::MaintenanceWindowTarget"
Properties:
  OwnerInformation: String
  Description: String
  WindowId: String
  ResourceType: String
  Targets: 
    - Targets
  Name: String

Properties

OwnerInformation

A user-provided value to include in any events in CloudWatch Events that are raised while running tasks for these targets in this Maintenance Window.

Required: No

Type: String

Update requires: No interruption

Description

A description for the target.

Required: No

Type: String

Update requires: No interruption

WindowId

The ID of the Maintenance Window to register the target with.

Required: Yes

Type: String

Update requires: Replacement

ResourceType

The type of target that's being registered with the Maintenance Window.

Required: Yes

Type: String

Valid values: INSTANCE

Update requires: No interruption

Targets

The targets, either instances or tags.

Specify instances using the following format:

Key=InstanceIds,Values=instance-id-1,instance-id-2

Specify tags using either of the following formats:

Key=tag:tag-key,Values=tag-value-1,tag-value-2

Key=tag-key,Values=tag-key-1,tag-key-2

Required: Yes

Type: List of Targets

Update requires: No interruption

Name

An optional name for the target.

Required: No

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::SSM::MaintenanceWindowTarget resource to the intrinsic Ref function, the function returns the maintenance window target ID, such as 12a345b6-bbb7-4bb6-90b0-8c9577a2d2b9.

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

See Also