Package software.amazon.awssdk.services.ssm.model

Class RegisterTargetWithMaintenanceWindowRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.RegisterTargetWithMaintenanceWindowRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterTargetWithMaintenanceWindowRequest extends SsmRequest implements ToCopyableBuilder<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>

  • Method Details

    • windowId

      public final String windowId()

      The ID of the maintenance window the target should be registered with.

      Returns:
      The ID of the maintenance window the target should be registered with.

    • resourceType

      public final MaintenanceWindowResourceType resourceType()

      The type of target 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 being registered with the maintenance window.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of target 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 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 to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

      If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

      You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

      Example 1: Specify managed node IDs

      Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>

      Example 2: Use tag key-pairs applied to managed nodes

      Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

      Example 3: Use tag-keys applied to managed nodes

      Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

      Example 4: Use resource group names

      Key=resource-groups:Name,Values=<resource-group-name>

      Example 5: Use filters for resource group types

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

      For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

      Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

      For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

      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 to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

      If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

      You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

      Example 1: Specify managed node IDs

      Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>

      Example 2: Use tag key-pairs applied to managed nodes

      Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

      Example 3: Use tag-keys applied to managed nodes

      Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

      Example 4: Use resource group names

      Key=resource-groups:Name,Values=<resource-group-name>

      Example 5: Use filters for resource group types

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

      For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

      Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

      For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

    • ownerInformation

      public final String ownerInformation()

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

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

    • name

      public final String name()

      An optional name for the target.

      Returns:
      An optional name for the target.

    • description

      public final String description()

      An optional description for the target.

      Returns:
      An optional description for the target.

    • clientToken

      public final String clientToken()

      User-provided idempotency token.

      Returns:
      User-provided idempotency token.

    • toBuilder

      public RegisterTargetWithMaintenanceWindowRequest.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<RegisterTargetWithMaintenanceWindowRequest.Builder,RegisterTargetWithMaintenanceWindowRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterTargetWithMaintenanceWindowRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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