io.cloudshiftdev.awscdk.services.batch.FargateComputeEnvironmentProps.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.batch
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.ec2.ISecurityGroup
import io.cloudshiftdev.awscdk.services.ec2.IVpc
import io.cloudshiftdev.awscdk.services.ec2.SubnetSelection
import io.cloudshiftdev.awscdk.services.iam.IRole
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Props for a FargateComputeEnvironment.
*
* Example:
*
* ```
* IVpc vpc;
* FargateComputeEnvironment sharedComputeEnv = FargateComputeEnvironment.Builder.create(this,
* "spotEnv")
* .vpc(vpc)
* .spot(true)
* .build();
* JobQueue lowPriorityQueue = JobQueue.Builder.create(this, "JobQueue")
* .priority(1)
* .build();
* JobQueue highPriorityQueue = JobQueue.Builder.create(this, "JobQueue")
* .priority(10)
* .build();
* lowPriorityQueue.addComputeEnvironment(sharedComputeEnv, 1);
* highPriorityQueue.addComputeEnvironment(sharedComputeEnv, 1);
* ```
*/
public interface FargateComputeEnvironmentProps : ManagedComputeEnvironmentProps {
/**
* A builder for [FargateComputeEnvironmentProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param computeEnvironmentName The name of the ComputeEnvironment.
*/
public fun computeEnvironmentName(computeEnvironmentName: String)
/**
* @param enabled Whether or not this ComputeEnvironment can accept jobs from a Queue.
* Enabled ComputeEnvironments can accept jobs from a Queue and
* can scale instances up or down.
* Disabled ComputeEnvironments cannot accept jobs from a Queue or
* scale instances up or down.
*
* If you change a ComputeEnvironment from enabled to disabled while it is executing jobs,
* Jobs in the `STARTED` or `RUNNING` states will not
* be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to
* `minvCpus`.
*
* To ensure you aren't billed for unused capacity, set `minvCpus` to `0`.
*/
public fun enabled(enabled: Boolean)
/**
* @param maxvCpus The maximum vCpus this `ManagedComputeEnvironment` can scale up to. Each vCPU
* is equivalent to 1024 CPU shares.
* *Note*: if this Compute Environment uses EC2 resources (not Fargate) with either
* `AllocationStrategy.BEST_FIT_PROGRESSIVE` or
* `AllocationStrategy.SPOT_CAPACITY_OPTIMIZED`, or `AllocationStrategy.BEST_FIT` with Spot
* instances,
* The scheduler may exceed this number by at most one of the instances specified in
* `instanceTypes`
* or `instanceClasses`.
*/
public fun maxvCpus(maxvCpus: Number)
/**
* @param replaceComputeEnvironment Specifies whether this Compute Environment is replaced if an
* update is made that requires replacing its instances.
* To enable more properties to be updated,
* set this property to `false`. When changing the value of this property to false,
* do not change any other properties at the same time.
* If other properties are changed at the same time,
* and the change needs to be rolled back but it can't,
* it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state.
* You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state.
* However, if you can continue to roll it back,
* you can return the stack to its original settings and then try to update it again.
*
* The properties which require a replacement of the Compute Environment are:
*/
public fun replaceComputeEnvironment(replaceComputeEnvironment: Boolean)
/**
* @param securityGroups The security groups this Compute Environment will launch instances in.
*/
public fun securityGroups(securityGroups: List)
/**
* @param securityGroups The security groups this Compute Environment will launch instances in.
*/
public fun securityGroups(vararg securityGroups: ISecurityGroup)
/**
* @param serviceRole The role Batch uses to perform actions on your behalf in your account,
* such as provision instances to run your jobs.
*/
public fun serviceRole(serviceRole: IRole)
/**
* @param spot Whether or not to use spot instances.
* Spot instances are less expensive EC2 instances that can be
* reclaimed by EC2 at any time; your job will be given two minutes
* of notice before reclamation.
*/
public fun spot(spot: Boolean)
/**
* @param terminateOnUpdate Whether or not any running jobs will be immediately terminated when
* an infrastructure update occurs.
* If this is enabled, any terminated jobs may be retried, depending on the job's
* retry policy.
*/
public fun terminateOnUpdate(terminateOnUpdate: Boolean)
/**
* @param updateTimeout Only meaningful if `terminateOnUpdate` is `false`.
* If so,
* when an infrastructure update is triggered, any running jobs
* will be allowed to run until `updateTimeout` has expired.
*/
public fun updateTimeout(updateTimeout: Duration)
/**
* @param updateToLatestImageVersion Whether or not the AMI is updated to the latest one
* supported by Batch when an infrastructure update occurs.
* If you specify a specific AMI, this property will be ignored.
*/
public fun updateToLatestImageVersion(updateToLatestImageVersion: Boolean)
/**
* @param vpc VPC in which this Compute Environment will launch Instances.
*/
public fun vpc(vpc: IVpc)
/**
* @param vpcSubnets The VPC Subnets this Compute Environment will launch instances in.
*/
public fun vpcSubnets(vpcSubnets: SubnetSelection)
/**
* @param vpcSubnets The VPC Subnets this Compute Environment will launch instances in.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ebf225cf95c0666327e2b8f93b935ed403e4bbd259963e1b52b370d4c838acaa")
public fun vpcSubnets(vpcSubnets: SubnetSelection.Builder.() -> Unit)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps.Builder =
software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps.builder()
/**
* @param computeEnvironmentName The name of the ComputeEnvironment.
*/
override fun computeEnvironmentName(computeEnvironmentName: String) {
cdkBuilder.computeEnvironmentName(computeEnvironmentName)
}
/**
* @param enabled Whether or not this ComputeEnvironment can accept jobs from a Queue.
* Enabled ComputeEnvironments can accept jobs from a Queue and
* can scale instances up or down.
* Disabled ComputeEnvironments cannot accept jobs from a Queue or
* scale instances up or down.
*
* If you change a ComputeEnvironment from enabled to disabled while it is executing jobs,
* Jobs in the `STARTED` or `RUNNING` states will not
* be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to
* `minvCpus`.
*
* To ensure you aren't billed for unused capacity, set `minvCpus` to `0`.
*/
override fun enabled(enabled: Boolean) {
cdkBuilder.enabled(enabled)
}
/**
* @param maxvCpus The maximum vCpus this `ManagedComputeEnvironment` can scale up to. Each vCPU
* is equivalent to 1024 CPU shares.
* *Note*: if this Compute Environment uses EC2 resources (not Fargate) with either
* `AllocationStrategy.BEST_FIT_PROGRESSIVE` or
* `AllocationStrategy.SPOT_CAPACITY_OPTIMIZED`, or `AllocationStrategy.BEST_FIT` with Spot
* instances,
* The scheduler may exceed this number by at most one of the instances specified in
* `instanceTypes`
* or `instanceClasses`.
*/
override fun maxvCpus(maxvCpus: Number) {
cdkBuilder.maxvCpus(maxvCpus)
}
/**
* @param replaceComputeEnvironment Specifies whether this Compute Environment is replaced if an
* update is made that requires replacing its instances.
* To enable more properties to be updated,
* set this property to `false`. When changing the value of this property to false,
* do not change any other properties at the same time.
* If other properties are changed at the same time,
* and the change needs to be rolled back but it can't,
* it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state.
* You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state.
* However, if you can continue to roll it back,
* you can return the stack to its original settings and then try to update it again.
*
* The properties which require a replacement of the Compute Environment are:
*/
override fun replaceComputeEnvironment(replaceComputeEnvironment: Boolean) {
cdkBuilder.replaceComputeEnvironment(replaceComputeEnvironment)
}
/**
* @param securityGroups The security groups this Compute Environment will launch instances in.
*/
override fun securityGroups(securityGroups: List) {
cdkBuilder.securityGroups(securityGroups.map(ISecurityGroup.Companion::unwrap))
}
/**
* @param securityGroups The security groups this Compute Environment will launch instances in.
*/
override fun securityGroups(vararg securityGroups: ISecurityGroup): Unit =
securityGroups(securityGroups.toList())
/**
* @param serviceRole The role Batch uses to perform actions on your behalf in your account,
* such as provision instances to run your jobs.
*/
override fun serviceRole(serviceRole: IRole) {
cdkBuilder.serviceRole(serviceRole.let(IRole.Companion::unwrap))
}
/**
* @param spot Whether or not to use spot instances.
* Spot instances are less expensive EC2 instances that can be
* reclaimed by EC2 at any time; your job will be given two minutes
* of notice before reclamation.
*/
override fun spot(spot: Boolean) {
cdkBuilder.spot(spot)
}
/**
* @param terminateOnUpdate Whether or not any running jobs will be immediately terminated when
* an infrastructure update occurs.
* If this is enabled, any terminated jobs may be retried, depending on the job's
* retry policy.
*/
override fun terminateOnUpdate(terminateOnUpdate: Boolean) {
cdkBuilder.terminateOnUpdate(terminateOnUpdate)
}
/**
* @param updateTimeout Only meaningful if `terminateOnUpdate` is `false`.
* If so,
* when an infrastructure update is triggered, any running jobs
* will be allowed to run until `updateTimeout` has expired.
*/
override fun updateTimeout(updateTimeout: Duration) {
cdkBuilder.updateTimeout(updateTimeout.let(Duration.Companion::unwrap))
}
/**
* @param updateToLatestImageVersion Whether or not the AMI is updated to the latest one
* supported by Batch when an infrastructure update occurs.
* If you specify a specific AMI, this property will be ignored.
*/
override fun updateToLatestImageVersion(updateToLatestImageVersion: Boolean) {
cdkBuilder.updateToLatestImageVersion(updateToLatestImageVersion)
}
/**
* @param vpc VPC in which this Compute Environment will launch Instances.
*/
override fun vpc(vpc: IVpc) {
cdkBuilder.vpc(vpc.let(IVpc.Companion::unwrap))
}
/**
* @param vpcSubnets The VPC Subnets this Compute Environment will launch instances in.
*/
override fun vpcSubnets(vpcSubnets: SubnetSelection) {
cdkBuilder.vpcSubnets(vpcSubnets.let(SubnetSelection.Companion::unwrap))
}
/**
* @param vpcSubnets The VPC Subnets this Compute Environment will launch instances in.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("ebf225cf95c0666327e2b8f93b935ed403e4bbd259963e1b52b370d4c838acaa")
override fun vpcSubnets(vpcSubnets: SubnetSelection.Builder.() -> Unit): Unit =
vpcSubnets(SubnetSelection(vpcSubnets))
public fun build(): software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps,
) : CdkObject(cdkObject),
FargateComputeEnvironmentProps {
/**
* The name of the ComputeEnvironment.
*
* Default: - generated by CloudFormation
*/
override fun computeEnvironmentName(): String? = unwrap(this).getComputeEnvironmentName()
/**
* Whether or not this ComputeEnvironment can accept jobs from a Queue.
*
* Enabled ComputeEnvironments can accept jobs from a Queue and
* can scale instances up or down.
* Disabled ComputeEnvironments cannot accept jobs from a Queue or
* scale instances up or down.
*
* If you change a ComputeEnvironment from enabled to disabled while it is executing jobs,
* Jobs in the `STARTED` or `RUNNING` states will not
* be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to
* `minvCpus`.
*
* To ensure you aren't billed for unused capacity, set `minvCpus` to `0`.
*
* Default: true
*/
override fun enabled(): Boolean? = unwrap(this).getEnabled()
/**
* The maximum vCpus this `ManagedComputeEnvironment` can scale up to. Each vCPU is equivalent
* to 1024 CPU shares.
*
* *Note*: if this Compute Environment uses EC2 resources (not Fargate) with either
* `AllocationStrategy.BEST_FIT_PROGRESSIVE` or
* `AllocationStrategy.SPOT_CAPACITY_OPTIMIZED`, or `AllocationStrategy.BEST_FIT` with Spot
* instances,
* The scheduler may exceed this number by at most one of the instances specified in
* `instanceTypes`
* or `instanceClasses`.
*
* Default: 256
*/
override fun maxvCpus(): Number? = unwrap(this).getMaxvCpus()
/**
* Specifies whether this Compute Environment is replaced if an update is made that requires
* replacing its instances.
*
* To enable more properties to be updated,
* set this property to `false`. When changing the value of this property to false,
* do not change any other properties at the same time.
* If other properties are changed at the same time,
* and the change needs to be rolled back but it can't,
* it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state.
* You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state.
* However, if you can continue to roll it back,
* you can return the stack to its original settings and then try to update it again.
*
* The properties which require a replacement of the Compute Environment are:
*
* Default: false
*
* [Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html)
*/
override fun replaceComputeEnvironment(): Boolean? = unwrap(this).getReplaceComputeEnvironment()
/**
* The security groups this Compute Environment will launch instances in.
*
* Default: new security groups will be created
*/
override fun securityGroups(): List =
unwrap(this).getSecurityGroups()?.map(ISecurityGroup::wrap) ?: emptyList()
/**
* The role Batch uses to perform actions on your behalf in your account, such as provision
* instances to run your jobs.
*
* Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs
*/
override fun serviceRole(): IRole? = unwrap(this).getServiceRole()?.let(IRole::wrap)
/**
* Whether or not to use spot instances.
*
* Spot instances are less expensive EC2 instances that can be
* reclaimed by EC2 at any time; your job will be given two minutes
* of notice before reclamation.
*
* Default: false
*/
override fun spot(): Boolean? = unwrap(this).getSpot()
/**
* Whether or not any running jobs will be immediately terminated when an infrastructure update
* occurs.
*
* If this is enabled, any terminated jobs may be retried, depending on the job's
* retry policy.
*
* Default: false
*
* [Documentation](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html)
*/
override fun terminateOnUpdate(): Boolean? = unwrap(this).getTerminateOnUpdate()
/**
* Only meaningful if `terminateOnUpdate` is `false`.
*
* If so,
* when an infrastructure update is triggered, any running jobs
* will be allowed to run until `updateTimeout` has expired.
*
* Default: 30 minutes
*
* [Documentation](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html)
*/
override fun updateTimeout(): Duration? = unwrap(this).getUpdateTimeout()?.let(Duration::wrap)
/**
* Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure
* update occurs.
*
* If you specify a specific AMI, this property will be ignored.
*
* Default: true
*/
override fun updateToLatestImageVersion(): Boolean? =
unwrap(this).getUpdateToLatestImageVersion()
/**
* VPC in which this Compute Environment will launch Instances.
*/
override fun vpc(): IVpc = unwrap(this).getVpc().let(IVpc::wrap)
/**
* The VPC Subnets this Compute Environment will launch instances in.
*
* Default: new subnets will be created
*/
override fun vpcSubnets(): SubnetSelection? =
unwrap(this).getVpcSubnets()?.let(SubnetSelection::wrap)
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): FargateComputeEnvironmentProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps):
FargateComputeEnvironmentProps = CdkObjectWrappers.wrap(cdkObject) as?
FargateComputeEnvironmentProps ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: FargateComputeEnvironmentProps):
software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.batch.FargateComputeEnvironmentProps
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy