software.amazon.awssdk.services.ssm.model

Class Target

java.lang.Object

software.amazon.awssdk.services.ssm.model.Target

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Target.Builder,Target>

@Generated(value="software.amazon.awssdk:codegen")
public final class Target
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Target.Builder,Target>

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

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

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Target.Builder

Method Summary

Modifier and Type	Method and Description
static Target.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() User-defined criteria for sending commands that target instances that meet the criteria.
List<SdkField<?>>	sdkFields()
static Class<? extends Target.Builder>	serializableBuilderClass()
Target.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() User-defined criteria that maps to Key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public String key()

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.

values

public List<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 Amazon EC2 tags of ServerRole,WebServer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 Amazon EC2 tags of ServerRole,WebServer.

toBuilder

public Target.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Target.Builder,Target>

builder

public static Target.Builder builder()

serializableBuilderClass

public static Class<? extends Target.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo