Class Target

java.lang.Object
software.amazon.awssdk.services.ssm.model.Target
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Target.Builder,Target>
@Generated("software.amazon.awssdk:codegen") public final class Target extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Target.Builder,Target>

An array of search criteria that targets managed nodes 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.

For all Systems Manager tools:

  • Key=tag-key,Values=tag-value-1,tag-value-2

For Automation and Change Manager:

  • Key=tag:tag-key,Values=tag-value

  • Key=ResourceGroup,Values=resource-group-name

  • Key=ParameterValues,Values=value-1,value-2,value-3

  • To target all instances in the Amazon Web Services Region:

    • Key=AWS::EC2::Instance,Values=*

    • Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

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

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

  • Key=resource-groups:Name,Values=resource-group-name

  • Additionally, Maintenance Windows support targeting resource types:

    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

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

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

  • To target all instances in the Amazon Web Services Region:

    • Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

See Also:

  • Method Details

    • key

      public final String key()

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

      Returns:
      User-defined criteria for sending commands that target managed nodes that meet the criteria.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

      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.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.