AWS::SSM::MaintenanceWindowTask Target

The Target property type specifies targets (either instances or window target IDs). You specify instances by using Key=InstanceIds,Values=<instanceid1>,<instanceid2>. You specify window target IDs using Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2> for a maintenance window task in Amazon Systems Manager.

Target is a property of the AWS::SSM::MaintenanceWindowTask property type.

Note

To use resource-groups:Name as the key for a maintenance window target, specify the resource group as a AWS::SSM::MaintenanceWindowTarget type, and use the Ref function to specify the target for AWS::SSM::MaintenanceWindowTask. For an example, see Create a Run Command task that targets instances using a resource group name in AWS::SSM::MaintenanceWindowTask Examples.

Syntax

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

JSON


{
  "Key" : String,
  "Values" : [ String, ... ]
}

YAML


  Key: String
  Values: 
    - String

Properties

Key

User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the Amazon Systems Manager User Guide.

Required: Yes

Type: String

Minimum: 1

Maximum: 163

Pattern: ^[\p{L}\p{Z}\p{N}_.:/=\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name

Update requires: No interruption

Values

User-defined criteria that maps to Key. For example, if you specify InstanceIds, you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About 'register-task-with-maintenance-window' Options and Values in the Amazon Systems Manager User Guide.