Class: Aws::SSM::Types::Target

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass Target data as a hash:

{
  key: "TargetKey",
  values: ["TargetValue"],
}

An array of search criteria that targets instances using a Key,Value combination that you specify. ‘Targets` is required if you don’t provide one or more instance IDs in the call.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or InstanceIds. For more information about how to send commands that target instances using Key,Value parameters, see [Targeting Multiple Instances] in the *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting

Returns:

  • (String) 


12734
12735
12736
12737
12738
 
# File 'lib/aws-sdk-ssm/types.rb', line 12734

class Target < Struct.new(
  :key,
  :values)
  include Aws::Structure
end

#values ⇒ Array<String>

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole,WebServer. For more information about how to send commands that target instances using Key,Value parameters, see

Sending Commands to a Fleet][1

in the *AWS Systems Manager User

Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html

Returns:

  • (Array<String>) 


12734
12735
12736
12737
12738
 
# File 'lib/aws-sdk-ssm/types.rb', line 12734

class Target < Struct.new(
  :key,
  :values)
  include Aws::Structure
end