Package software.amazon.awscdk.services.batch

Class FargateComputeEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.batch.FargateComputeEnvironment
All Implemented Interfaces:
IResource, ITaggable, IComputeEnvironment, IFargateComputeEnvironment, IManagedComputeEnvironment, IConnectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:39.405Z") @Stability(Stable) public class FargateComputeEnvironment extends Resource implements IFargateComputeEnvironment, IManagedComputeEnvironment, IComputeEnvironment
A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

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);

  • Constructor Details

    • FargateComputeEnvironment

      protected FargateComputeEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • FargateComputeEnvironment

      protected FargateComputeEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • FargateComputeEnvironment

      @Stability(Stable) public FargateComputeEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull FargateComputeEnvironmentProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromFargateComputeEnvironmentArn

      @Stability(Stable) @NotNull public static IFargateComputeEnvironment fromFargateComputeEnvironmentArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String fargateComputeEnvironmentArn)
      Reference an existing FargateComputeEnvironment by its arn.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      fargateComputeEnvironmentArn - This parameter is required.

    • getComputeEnvironmentArn

      @Stability(Stable) @NotNull public String getComputeEnvironmentArn()
      The ARN of this compute environment.
      Specified by:
      getComputeEnvironmentArn in interface IComputeEnvironment

    • getComputeEnvironmentName

      @Stability(Stable) @NotNull public String getComputeEnvironmentName()
      The name of the ComputeEnvironment.
      Specified by:
      getComputeEnvironmentName in interface IComputeEnvironment

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      The network connections associated with this resource.
      Specified by:
      getConnections in interface IConnectable

    • getEnabled

      @Stability(Stable) @NotNull public Boolean getEnabled()
      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.

      Specified by:
      getEnabled in interface IComputeEnvironment

    • getMaxvCpus

      @Stability(Stable) @NotNull public Number getMaxvCpus()
      The maximum vCpus this ManagedComputeEnvironment can scale up to.

      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.

      Specified by:
      getMaxvCpus in interface IManagedComputeEnvironment

    • getSecurityGroups

      @Stability(Stable) @NotNull public List<ISecurityGroup> getSecurityGroups()
      The security groups this Compute Environment will launch instances in.
      Specified by:
      getSecurityGroups in interface IManagedComputeEnvironment

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      TagManager to set, remove and format tags.
      Specified by:
      getTags in interface ITaggable

    • getReplaceComputeEnvironment

      @Stability(Stable) @Nullable public Boolean getReplaceComputeEnvironment()
      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:

      Specified by:
      getReplaceComputeEnvironment in interface IManagedComputeEnvironment
      See Also:

    • getServiceRole

      @Stability(Stable) @Nullable public IRole getServiceRole()
      The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
      Specified by:
      getServiceRole in interface IComputeEnvironment

    • getSpot

      @Stability(Stable) @Nullable public Boolean getSpot()
      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.

      Specified by:
      getSpot in interface IManagedComputeEnvironment

    • getTerminateOnUpdate

      @Stability(Stable) @Nullable public Boolean getTerminateOnUpdate()
      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.

      Specified by:
      getTerminateOnUpdate in interface IManagedComputeEnvironment
      See Also:

    • getUpdateTimeout

      @Stability(Stable) @Nullable public Duration getUpdateTimeout()
      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.

      Specified by:
      getUpdateTimeout in interface IManagedComputeEnvironment
      See Also:

    • getUpdateToLatestImageVersion

      @Stability(Stable) @Nullable public Boolean getUpdateToLatestImageVersion()
      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.

      Note: the CDK will never set this value by default, false will set by CFN. This is to avoid a deployment failure that occurs when this value is set.

      Specified by:
      getUpdateToLatestImageVersion in interface IManagedComputeEnvironment
      See Also: