Package software.amazon.awscdk.services.batch

Interface IManagedComputeEnvironment.Jsii$Default

All Superinterfaces:
IComputeEnvironment, IComputeEnvironment.Jsii$Default, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IManagedComputeEnvironment, IResource, IResource.Jsii$Default, ITaggable, ITaggable.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IFargateComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment.Jsii$Default
All Known Implementing Classes:
IFargateComputeEnvironment.Jsii$Proxy, IManagedComputeEnvironment.Jsii$Proxy, IManagedEc2EcsComputeEnvironment.Jsii$Proxy
Enclosing interface:
IManagedComputeEnvironment
@Internal public static interface IManagedComputeEnvironment.Jsii$Default extends IManagedComputeEnvironment, ITaggable.Jsii$Default, IComputeEnvironment.Jsii$Default, IConnectable.Jsii$Default
Internal default implementation for IManagedComputeEnvironment.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface IComputeEnvironment.Jsii$Default
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IComputeEnvironment.Jsii$Default
      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IComputeEnvironment.Jsii$Default
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getComputeEnvironmentArn

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

    • getComputeEnvironmentName

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

    • getEnabled

      @Stability(Stable) @NotNull default 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
      Specified by:
      getEnabled in interface IComputeEnvironment.Jsii$Default

    • getServiceRole

      @Stability(Stable) @Nullable default IRole getServiceRole()
      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

      Specified by:
      getServiceRole in interface IComputeEnvironment
      Specified by:
      getServiceRole in interface IComputeEnvironment.Jsii$Default

    • getConnections

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

    • getTags

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

    • getMaxvCpus

      @Stability(Stable) @NotNull default 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 default List<ISecurityGroup> getSecurityGroups()
      The security groups this Compute Environment will launch instances in.
      Specified by:
      getSecurityGroups in interface IManagedComputeEnvironment

    • getReplaceComputeEnvironment

      @Stability(Stable) @Nullable default 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:

    • getSpot

      @Stability(Stable) @Nullable default 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.

      Default: false

      Specified by:
      getSpot in interface IManagedComputeEnvironment

    • getTerminateOnUpdate

      @Stability(Stable) @Nullable default 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.

      Default: false

      Specified by:
      getTerminateOnUpdate in interface IManagedComputeEnvironment
      See Also:

    • getUpdateTimeout

      @Stability(Stable) @Nullable default 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.

      Default: 30 minutes

      Specified by:
      getUpdateTimeout in interface IManagedComputeEnvironment
      See Also:

    • getUpdateToLatestImageVersion

      @Stability(Stable) @Nullable default 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.

      Default: false

      Specified by:
      getUpdateToLatestImageVersion in interface IManagedComputeEnvironment
      See Also:

    • getVpcSubnets

      @Stability(Stable) @Nullable default SubnetSelection getVpcSubnets()
      The VPC Subnets this Compute Environment will launch instances in.
      Specified by:
      getVpcSubnets in interface IManagedComputeEnvironment

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IComputeEnvironment.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.