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
• Struct
• Aws::SSM::Types::Target

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #key ⇒ String

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

• #values ⇒ Array<String>

  User-defined criteria that maps to Key.

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 Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14888

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 run 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 Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14888

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