You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

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 Executing a Command Using Systems Manager Run Command.

Returns:

  • (String)


9222
9223
9224
9225
9226
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9222

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

#valuesArray<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 Executing a Command Using Systems Manager Run Command.

Returns:

  • (Array<String>)


9222
9223
9224
9225
9226
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9222

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