Class PutWarmPoolRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutWarmPoolRequest.Builder,
PutWarmPoolRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the Auto Scaling group.static PutWarmPoolRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final InstanceReusePolicy
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.final Integer
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state exceptTerminated
for the Auto Scaling group.final Integer
minSize()
Specifies the minimum number of instances to maintain in the warm pool.final WarmPoolState
Sets the instance state to transition to after the lifecycle actions are complete.final String
Sets the instance state to transition to after the lifecycle actions are complete.static Class
<? extends PutWarmPoolRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
autoScalingGroupName
The name of the Auto Scaling group.
- Returns:
- The name of the Auto Scaling group.
-
maxGroupPreparedCapacity
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except
Terminated
for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.If a value for
MaxGroupPreparedCapacity
is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value forMaxGroupPreparedCapacity
, Amazon EC2 Auto Scaling uses the difference between theMaxGroupPreparedCapacity
and the desired capacity instead.The size of the warm pool is dynamic. Only when
MaxGroupPreparedCapacity
andMinSize
are set to the same value does the warm pool have an absolute size.If the desired capacity of the Auto Scaling group is higher than the
MaxGroupPreparedCapacity
, the capacity of the warm pool is 0, unless you specify a value forMinSize
. To remove a value that you previously set, include the property but specify -1 for the value.- Returns:
- Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except
Terminated
for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.If a value for
MaxGroupPreparedCapacity
is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value forMaxGroupPreparedCapacity
, Amazon EC2 Auto Scaling uses the difference between theMaxGroupPreparedCapacity
and the desired capacity instead.The size of the warm pool is dynamic. Only when
MaxGroupPreparedCapacity
andMinSize
are set to the same value does the warm pool have an absolute size.If the desired capacity of the Auto Scaling group is higher than the
MaxGroupPreparedCapacity
, the capacity of the warm pool is 0, unless you specify a value forMinSize
. To remove a value that you previously set, include the property but specify -1 for the value.
-
minSize
Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.
- Returns:
- Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.
-
poolState
Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
.If the service returns an enum value that is not available in the current SDK version,
poolState
will returnWarmPoolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompoolStateAsString()
.- Returns:
- Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
. - See Also:
-
poolStateAsString
Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
.If the service returns an enum value that is not available in the current SDK version,
poolState
will returnWarmPoolState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompoolStateAsString()
.- Returns:
- Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped
. - See Also:
-
instanceReusePolicy
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
- Returns:
- Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
-
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 interfaceToCopyableBuilder<PutWarmPoolRequest.Builder,
PutWarmPoolRequest> - Specified by:
toBuilder
in classAutoScalingRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-