Package software.amazon.awssdk.services.autoscaling.model

Class ScheduledUpdateGroupActionRequest

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

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

See Also:

  • Method Details

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scaling action.

      Returns:
      The name of the scaling action.

    • startTime

      public final Instant startTime()

      The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

      If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

      If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

      Returns:
      The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

      If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

      If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

    • endTime

      public final Instant endTime()

      The date and time for the recurring schedule to end, in UTC.

      Returns:
      The date and time for the recurring schedule to end, in UTC.

    • recurrence

      public final String recurrence()

      The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

      Cron expressions use Universal Coordinated Time (UTC) by default.

      Returns:
      The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

      Cron expressions use Universal Coordinated Time (UTC) by default.

    • minSize

      public final Integer minSize()

      The minimum size of the Auto Scaling group.

      Returns:
      The minimum size of the Auto Scaling group.

    • maxSize

      public final Integer maxSize()

      The maximum size of the Auto Scaling group.

      Returns:
      The maximum size of the Auto Scaling group.

    • desiredCapacity

      public final Integer desiredCapacity()

      The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

      Returns:
      The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

    • timeZone

      public final String timeZone()

      Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

      Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

      Returns:
      Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

      Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

    • toBuilder

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

    • builder

      public static ScheduledUpdateGroupActionRequest.Builder builder()

    • serializableBuilderClass

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