Class MaintenanceWindowTarget

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

The target registered with the maintenance window.

See Also:

  • Method Details

    • windowId

      public final String windowId()

      The ID of the maintenance window to register the target with.

      Returns:
      The ID of the maintenance window to register the target with.

    • windowTargetId

      public final String windowTargetId()

      The ID of the target.

      Returns:
      The ID of the target.

    • resourceType

      public final MaintenanceWindowResourceType resourceType()

      The type of target that is being registered with the maintenance window.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of target that is being registered with the maintenance window.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of target that is being registered with the maintenance window.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return MaintenanceWindowResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of target that is being registered with the maintenance window.
      See Also:

    • hasTargets

      public final boolean hasTargets()
      For responses, this returns true if the service returned a value for the Targets 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.

    • targets

      public final List<Target> targets()

      The targets, either managed nodes or tags.

      Specify managed nodes using the following format:

      Key=instanceids,Values=<instanceid1>,<instanceid2>

      Tags are specified using the following format:

      Key=<tag name>,Values=<tag value>.

      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 hasTargets() method.

      Returns:
      The targets, either managed nodes or tags.

      Specify managed nodes using the following format:

      Key=instanceids,Values=<instanceid1>,<instanceid2>

      Tags are specified using the following format:

      Key=<tag name>,Values=<tag value>.

    • ownerInformation

      public final String ownerInformation()

      A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

      Returns:
      A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

    • name

      public final String name()

      The name for the maintenance window target.

      Returns:
      The name for the maintenance window target.

    • description

      public final String description()

      A description for the target.

      Returns:
      A description for the target.

    • toBuilder

      public MaintenanceWindowTarget.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<MaintenanceWindowTarget.Builder,MaintenanceWindowTarget>
      Returns:
      a builder for type T

    • builder

      public static MaintenanceWindowTarget.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MaintenanceWindowTarget.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.