Interface PutScheduledUpdateGroupActionRequest.Builder
- All Superinterfaces:
AutoScalingRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<PutScheduledUpdateGroupActionRequest.Builder,
,PutScheduledUpdateGroupActionRequest> SdkBuilder<PutScheduledUpdateGroupActionRequest.Builder,
,PutScheduledUpdateGroupActionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutScheduledUpdateGroupActionRequest
-
Method Summary
Modifier and TypeMethodDescriptionautoScalingGroupName
(String autoScalingGroupName) The name of the Auto Scaling group.desiredCapacity
(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.The date and time for the recurring schedule to end, in UTC.The maximum size of the Auto Scaling group.The minimum size of the Auto Scaling group.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.recurrence
(String recurrence) The recurring schedule for this action.scheduledActionName
(String scheduledActionName) The name of this scaling action.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"
).This property is no longer used.Specifies the time zone for a cron expression.Methods inherited from interface software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
autoScalingGroupName
The name of the Auto Scaling group.
- Parameters:
autoScalingGroupName
- The name of the Auto Scaling group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduledActionName
The name of this scaling action.
- Parameters:
scheduledActionName
- The name of this scaling action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
time
This property is no longer used.
- Parameters:
time
- This property is no longer used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
andStartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.- Parameters:
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
andStartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The date and time for the recurring schedule to end, in UTC. For example,
"2021-06-01T00:00:00Z"
.- Parameters:
endTime
- The date and time for the recurring schedule to end, in UTC. For example,"2021-06-01T00:00:00Z"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
- Parameters:
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
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:
- Returns a reference to this object so that method calls can be chained together.
-
minSize
The minimum size of the Auto Scaling group.
- Parameters:
minSize
- The minimum size of the Auto Scaling group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxSize
The maximum size of the Auto Scaling group.
- Parameters:
maxSize
- The maximum size of the Auto Scaling group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orDesiredCapacity
.- Parameters:
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
, orDesiredCapacity
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
PutScheduledUpdateGroupActionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PutScheduledUpdateGroupActionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-