Skip to content

/AWS1/CL_SSMTARGET

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager capabilities:

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

For Automation and Change Manager:

  • Key=tag:tag-key,Values=tag-value

  • Key=ResourceGroup,Values=resource-group-name

  • Key=ParameterValues,Values=value-1,value-2,value-3

  • To target all instances in the Amazon Web Services Region:

    • Key=AWS::EC2::Instance,Values=*

    • Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

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

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

  • Key=resource-groups:Name,Values=resource-group-name

  • Additionally, Maintenance Windows support targeting resource types:

    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

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

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

  • To target all instances in the Amazon Web Services Region:

    • Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_KEY TYPE /AWS1/SSMTARGETKEY /AWS1/SSMTARGETKEY

User-defined criteria for sending commands that target managed nodes that meet the criteria.

IT_VALUES TYPE /AWS1/CL_SSMTARGETVALUES_W=>TT_TARGETVALUES TT_TARGETVALUES

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Queryable Attributes

Key

User-defined criteria for sending commands that target managed nodes that meet the criteria.

Accessible with the following methods

Method Description
GET_KEY() Getter for KEY, with configurable default
ASK_KEY() Getter for KEY w/ exceptions if field has no value
HAS_KEY() Determine if KEY has a value

Values

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

Accessible with the following methods

Method Description
GET_VALUES() Getter for VALUES, with configurable default
ASK_VALUES() Getter for VALUES w/ exceptions if field has no value
HAS_VALUES() Determine if VALUES has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_TARGETS

TYPES TT_TARGETS TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMTARGET WITH DEFAULT KEY
.