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.

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.

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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

key

public final 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.

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

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

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

You can use hasValues() to see if a value was sent in this field.

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.

toBuilder

public Target.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Target.Builder,Target>

Returns:

a builder for type T

builder

public static Target.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.