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(value="software.amazon.awssdk:codegen")
public final class ScheduledUpdateGroupActionRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledUpdateGroupActionRequest.Builder,ScheduledUpdateGroupActionRequest>

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScheduledUpdateGroupActionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ScheduledUpdateGroupActionRequest.Builder	builder()
Integer	desiredCapacity() The number of EC2 instances that should be running in the group.
Instant	endTime() The date and time for the recurring schedule to end.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxSize() The maximum number of instances in the Auto Scaling group.
Integer	minSize() The minimum number of instances in 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").
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 String scheduledActionName()

The name of the scaling action.

Returns:

The name of the scaling action.

startTime

public 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 Instant endTime()

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

Returns:

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

recurrence

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

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.

minSize

public Integer minSize()

The minimum number of instances in the Auto Scaling group.

Returns:

The minimum number of instances in the Auto Scaling group.

maxSize

public Integer maxSize()

The maximum number of instances in the Auto Scaling group.

Returns:

The maximum number of instances in the Auto Scaling group.

desiredCapacity

public Integer desiredCapacity()

The number of EC2 instances that should be running in the group.

Returns:

The number of EC2 instances that should be running in the group.

toBuilder

public ScheduledUpdateGroupActionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledUpdateGroupActionRequest.Builder,ScheduledUpdateGroupActionRequest>

builder

public static ScheduledUpdateGroupActionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo