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.

Supported formats include the following.

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

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

  • ‘Key=tag-key,Values=my-tag-key-1,my-tag-key-2 `

  • (Maintenance window targets only) ‘Key=resource-groups:Name,Values=resource-group-name `

  • (Maintenance window targets only) ‘Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2 `

For example:

  • ‘Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE`

  • ‘Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3`

  • ‘Key=tag-key,Values=Name,Instance-Type,CostCenter`

  • (Maintenance window targets only) ‘Key=resource-groups:Name,Values=ProductionResourceGroup`

    This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

  • (Maintenance window targets only) ‘Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC `

    This example demonstrates how to target only Amazon EC2 instances and VPCs in your maintenance window.

  • (State Manager association targets only) ‘Key=InstanceIds,Values=* `

    This example demonstrates how to target all managed instances in the AWS Region where the association was created.

For 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*.

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) 


15495
15496
15497
15498
15499
 
# File 'lib/aws-sdk-ssm/types.rb', line 15495

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`.

Returns:

  • (Array<String>) 


15495
15496
15497
15498
15499
 
# File 'lib/aws-sdk-ssm/types.rb', line 15495

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