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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ScheduledUpdateGroupActionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ScheduledUpdateGroupActionRequest.Builder
builder()
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.Instant
endTime()
The date and time for the recurring schedule to end, in UTC.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
maxSize()
The maximum size of the Auto Scaling group.Integer
minSize()
The minimum size of the Auto Scaling group.String
recurrence()
The recurring schedule for the action, in Unix cron syntax format.String
scheduledActionName()
The name of the scaling action.List<SdkField<?>>
sdkFields()
static Class<? extends ScheduledUpdateGroupActionRequest.Builder>
serializableBuilderClass()
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"
).String
timeZone()
Specifies the time zone for a cron expression.ScheduledUpdateGroupActionRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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
andStartTime
, 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
andStartTime
, 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
andEndTime
are specified withRecurrence
, 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
andEndTime
are specified withRecurrence
, 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
orPacific/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
orPacific/Tahiti
). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
-
toBuilder
public ScheduledUpdateGroupActionRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ScheduledUpdateGroupActionRequest.Builder,ScheduledUpdateGroupActionRequest>
-
builder
public static ScheduledUpdateGroupActionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ScheduledUpdateGroupActionRequest.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-