@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 combination 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, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see Registering maintenance window tasks without targets in the AWS 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 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 AWS 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 AWS Systems Manager User Guide.
| Constructor and Description |
|---|
Target() |
| 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)
Marshalls this structured data using the given
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. |
public void setKey(String key)
User-defined criteria for sending commands that target instances that meet the criteria.
key - User-defined criteria for sending commands that target instances that meet the criteria.public String getKey()
User-defined criteria for sending commands that target instances that meet the criteria.
public Target withKey(String key)
User-defined criteria for sending commands that target instances that meet the criteria.
key - User-defined criteria for sending commands that target instances that meet the criteria.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.
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.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.
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.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.
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.
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.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.
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.public String toString()
toString in class ObjectObject.toString()public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.