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

Class PutScheduledUpdateGroupActionRequest

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

  • Method Details

    • autoScalingGroupName

      public final String autoScalingGroupName()

      The name of the Auto Scaling group.

      Returns:
      The name of the Auto Scaling group.

    • scheduledActionName

      public final String scheduledActionName()

      The name of this scaling action.

      Returns:
      The name of this scaling action.

    • time

      public final Instant time()

      This property is no longer used.

      Returns:
      This property is no longer used.

    • startTime

      public final Instant startTime()

      The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-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.

      Returns:
      The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-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.

    • endTime

      public final Instant endTime()

      The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".

      Returns:
      The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".

    • recurrence

      public final String recurrence()

      The recurring schedule for this action. 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 this action. 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. It can scale beyond this capacity if you add more scaling conditions.

      You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity.

      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. It can scale beyond this capacity if you add more scaling conditions.

      You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity.

    • 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 PutScheduledUpdateGroupActionRequest.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<PutScheduledUpdateGroupActionRequest.Builder,PutScheduledUpdateGroupActionRequest>
      Specified by:
      toBuilder in class AutoScalingRequest
      Returns:
      a builder for type T

    • builder

      public static PutScheduledUpdateGroupActionRequest.Builder builder()

    • serializableBuilderClass

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