cloudshift.awscdk.dsl.services.autoscaling.CfnWarmPoolPropsDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.autoscaling
import cloudshift.awscdk.common.CdkDslMarker
import kotlin.Number
import kotlin.String
import software.amazon.awscdk.IResolvable
import software.amazon.awscdk.services.autoscaling.CfnWarmPool
import software.amazon.awscdk.services.autoscaling.CfnWarmPoolProps
/**
* Properties for defining a `CfnWarmPool`.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.autoscaling.*;
* CfnWarmPoolProps cfnWarmPoolProps = CfnWarmPoolProps.builder()
* .autoScalingGroupName("autoScalingGroupName")
* // the properties below are optional
* .instanceReusePolicy(InstanceReusePolicyProperty.builder()
* .reuseOnScaleIn(false)
* .build())
* .maxGroupPreparedCapacity(123)
* .minSize(123)
* .poolState("poolState")
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html)
*/
@CdkDslMarker
public class CfnWarmPoolPropsDsl {
private val cdkBuilder: CfnWarmPoolProps.Builder = CfnWarmPoolProps.builder()
/**
* @param autoScalingGroupName The name of the Auto Scaling group.
*/
public fun autoScalingGroupName(autoScalingGroupName: String) {
cdkBuilder.autoScalingGroupName(autoScalingGroupName)
}
/**
* @param 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.
*/
public fun instanceReusePolicy(instanceReusePolicy: IResolvable) {
cdkBuilder.instanceReusePolicy(instanceReusePolicy)
}
/**
* @param 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.
*/
public fun instanceReusePolicy(instanceReusePolicy: CfnWarmPool.InstanceReusePolicyProperty) {
cdkBuilder.instanceReusePolicy(instanceReusePolicy)
}
/**
* @param 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 for `MaxGroupPreparedCapacity` , Amazon EC2 Auto Scaling uses the difference
* between the `MaxGroupPreparedCapacity` and the desired capacity instead.
*
* The size of the warm pool is dynamic. Only when `MaxGroupPreparedCapacity` and `MinSize` 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 for `MinSize` . To remove a value
* that you previously set, include the property but specify -1 for the value.
*/
public fun maxGroupPreparedCapacity(maxGroupPreparedCapacity: Number) {
cdkBuilder.maxGroupPreparedCapacity(maxGroupPreparedCapacity)
}
/**
* @param 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.
*/
public fun minSize(minSize: Number) {
cdkBuilder.minSize(minSize)
}
/**
* @param poolState Sets the instance state to transition to after the lifecycle actions are
* complete.
* Default is `Stopped` .
*/
public fun poolState(poolState: String) {
cdkBuilder.poolState(poolState)
}
public fun build(): CfnWarmPoolProps = cdkBuilder.build()
}