Target (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.12.52 API)

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.Target

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Target
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An array of search criteria that targets instances 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.
- 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
- Run Command and 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
- Automation targets only: Key=ResourceGroup;Values=resource-group-name
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
- Run Command and 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 Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.
- Automation targets only: Key=ResourceGroup,Values=MyResourceGroup
- State Manager association targets only: Key=InstanceIds,Values=*
  
  This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.
For more information about how to send commands that target instances using Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Target()

Constructors
Constructor and Description
`Target()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Target`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKey()` User-defined criteria for sending commands that target instances that meet the criteria.
`List<String>`	`getValues()` User-defined criteria that maps to `Key`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setKey(String key)` User-defined criteria for sending commands that target instances that meet the criteria.
`void`	`setValues(Collection<String> values)` User-defined criteria that maps to `Key`.
`String`	`toString()` Returns a string representation of this object.
`Target`	`withKey(String key)` User-defined criteria for sending commands that target instances that meet the criteria.
`Target`	`withValues(Collection<String> values)` User-defined criteria that maps to `Key`.
`Target`	`withValues(String... values)` User-defined criteria that maps to `Key`.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Target
```
public Target()
```
- Method Detail
  - setKey
```
public void setKey(String key)
```
    User-defined criteria for sending commands that target instances that meet the criteria.
    
    Parameters:
    
    key - User-defined criteria for sending commands that target instances that meet the criteria.
  - getKey
```
public String getKey()
```
    User-defined criteria for sending commands that target instances that meet the criteria.
    
    Returns:
    
    User-defined criteria for sending commands that target instances that meet the criteria.
  - withKey
```
public Target withKey(String key)
```
    User-defined criteria for sending commands that target instances that meet the criteria.
    
    Parameters:
    
    key - User-defined criteria for sending commands that target instances that meet the criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValues
```
public List<String> getValues()
```
    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.
    
    Returns:
    
    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.
  - setValues
```
public void setValues(Collection<String> 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.
    
    Parameters:
    
    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.
  - withValues
```
public Target withValues(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public Target withValues(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Target clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Target

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Target

Method Detail

setKey

getKey

withKey

getValues

setValues

withValues

withValues

toString

equals

hashCode

clone

marshall