Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.ecs
import cloudshift.awscdk.common.CdkDslMarker
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import software.amazon.awscdk.services.autoscaling.IAutoScalingGroup
import software.amazon.awscdk.services.ecs.AsgCapacityProvider
import software.amazon.awscdk.services.ecs.MachineImageType
import software.amazon.awscdk.services.kms.IKey
import software.constructs.Construct
/**
* An Auto Scaling Group Capacity Provider.
*
* This allows an ECS cluster to target
* a specific EC2 Auto Scaling Group for the placement of tasks. Optionally (and
* recommended), ECS can manage the number of instances in the ASG to fit the
* tasks, and can ensure that instances are not prematurely terminated while
* there are still tasks running on them.
*
* Example:
*
* ```
* Vpc vpc;
* Cluster cluster = Cluster.Builder.create(this, "Cluster")
* .vpc(vpc)
* .build();
* // Either add default capacity
* cluster.addCapacity("DefaultAutoScalingGroupCapacity", AddCapacityOptions.builder()
* .instanceType(new InstanceType("t2.xlarge"))
* .desiredCapacity(3)
* .build());
* // Or add customized capacity. Be sure to start the Amazon ECS-optimized AMI.
* AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "ASG")
* .vpc(vpc)
* .instanceType(new InstanceType("t2.xlarge"))
* .machineImage(EcsOptimizedImage.amazonLinux())
* // Or use Amazon ECS-Optimized Amazon Linux 2 AMI
* // machineImage: EcsOptimizedImage.amazonLinux2(),
* .desiredCapacity(3)
* .build();
* AsgCapacityProvider capacityProvider = AsgCapacityProvider.Builder.create(this,
* "AsgCapacityProvider")
* .autoScalingGroup(autoScalingGroup)
* .build();
* cluster.addAsgCapacityProvider(capacityProvider);
* ```
*/
@CdkDslMarker
public class AsgCapacityProviderDsl(
scope: Construct,
id: String,
) {
private val cdkBuilder: AsgCapacityProvider.Builder = AsgCapacityProvider.Builder.create(scope,
id)
/**
* The autoscaling group to add as a Capacity Provider.
*
* @param autoScalingGroup The autoscaling group to add as a Capacity Provider.
*/
public fun autoScalingGroup(autoScalingGroup: IAutoScalingGroup) {
cdkBuilder.autoScalingGroup(autoScalingGroup)
}
/**
* Specifies whether the containers can access the container instance role.
*
* Default: false
*
* @param canContainersAccessInstanceRole Specifies whether the containers can access the
* container instance role.
*/
public fun canContainersAccessInstanceRole(canContainersAccessInstanceRole: Boolean) {
cdkBuilder.canContainersAccessInstanceRole(canContainersAccessInstanceRole)
}
/**
* The name of the capacity provider.
*
* If a name is specified,
* it cannot start with `aws`, `ecs`, or `fargate`. If no name is specified,
* a default name in the CFNStackName-CFNResourceName-RandomString format is used.
*
* Default: CloudFormation-generated name
*
* @param capacityProviderName The name of the capacity provider.
*/
public fun capacityProviderName(capacityProviderName: String) {
cdkBuilder.capacityProviderName(capacityProviderName)
}
/**
* When enabled the scale-in and scale-out actions of the cluster's Auto Scaling Group will be
* managed for you.
*
* This means your cluster will automatically scale instances based on the load your tasks put on
* the cluster.
* For more information, see [Using Managed
* Scaling](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling)
* in the ECS Developer Guide.
*
* Default: true
*
* @param enableManagedScaling When enabled the scale-in and scale-out actions of the cluster's
* Auto Scaling Group will be managed for you.
*/
public fun enableManagedScaling(enableManagedScaling: Boolean) {
cdkBuilder.enableManagedScaling(enableManagedScaling)
}
/**
* When enabled the Auto Scaling Group will only terminate EC2 instances that no longer have
* running non-daemon tasks.
*
* Scale-in protection will be automatically enabled on instances. When all non-daemon tasks are
* stopped on an instance, ECS initiates the scale-in process and turns off scale-in protection
* for the
* instance. The Auto Scaling Group can then terminate the instance. For more information see Managed
* termination
* protection
* in the ECS Developer Guide.
*
* Managed scaling must also be enabled.
*
* Default: true
*
* @param enableManagedTerminationProtection When enabled the Auto Scaling Group will only
* terminate EC2 instances that no longer have running non-daemon tasks.
*/
public fun enableManagedTerminationProtection(enableManagedTerminationProtection: Boolean) {
cdkBuilder.enableManagedTerminationProtection(enableManagedTerminationProtection)
}
/**
* What type of machine image this is.
*
* Depending on the setting, different UserData will automatically be added
* to the `AutoScalingGroup` to configure it properly for use with ECS.
*
* If you create an `AutoScalingGroup` yourself and are adding it via
* `addAutoScalingGroup()`, you must specify this value. If you are adding an
* `autoScalingGroup` via `addCapacity`, this value will be determined
* from the `machineImage` you pass.
*
* Default: - Automatically determined from `machineImage`, if available, otherwise
* `MachineImageType.AMAZON_LINUX_2`.
*
* @param machineImageType What type of machine image this is.
*/
public fun machineImageType(machineImageType: MachineImageType) {
cdkBuilder.machineImageType(machineImageType)
}
/**
* Maximum scaling step size.
*
* In most cases this should be left alone.
*
* Default: 1000
*
* @param maximumScalingStepSize Maximum scaling step size.
*/
public fun maximumScalingStepSize(maximumScalingStepSize: Number) {
cdkBuilder.maximumScalingStepSize(maximumScalingStepSize)
}
/**
* Minimum scaling step size.
*
* In most cases this should be left alone.
*
* Default: 1
*
* @param minimumScalingStepSize Minimum scaling step size.
*/
public fun minimumScalingStepSize(minimumScalingStepSize: Number) {
cdkBuilder.minimumScalingStepSize(minimumScalingStepSize)
}
/**
* Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
*
* For more information, see [Using Spot
* Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html).
*
* Default: false
*
* @param spotInstanceDraining Specify whether to enable Automated Draining for Spot Instances
* running Amazon ECS Services.
*/
public fun spotInstanceDraining(spotInstanceDraining: Boolean) {
cdkBuilder.spotInstanceDraining(spotInstanceDraining)
}
/**
* Target capacity percent.
*
* In most cases this should be left alone.
*
* Default: 100
*
* @param targetCapacityPercent Target capacity percent.
*/
public fun targetCapacityPercent(targetCapacityPercent: Number) {
cdkBuilder.targetCapacityPercent(targetCapacityPercent)
}
/**
* If `AddAutoScalingGroupCapacityOptions.taskDrainTime` is non-zero, then the ECS cluster creates
* an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut
* down. If this property is provided, then this key will be used to encrypt the contents of that SNS
* Topic. See [SNS Data
* Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more
* information.
*
* Default: The SNS Topic will not be encrypted.
*
* @param topicEncryptionKey If `AddAutoScalingGroupCapacityOptions.taskDrainTime` is non-zero,
* then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when
* the instance is being shut down. If this property is provided, then this key will be used to
* encrypt the contents of that SNS Topic. See [SNS Data
* Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more
* information.
*/
public fun topicEncryptionKey(topicEncryptionKey: IKey) {
cdkBuilder.topicEncryptionKey(topicEncryptionKey)
}
public fun build(): AsgCapacityProvider = cdkBuilder.build()
}
