Package software.amazon.awscdk.services.batch

Interface IComputeEnvironment.Jsii$Default

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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IComputeEnvironment

    IComputeEnvironment.Jsii$Default, IComputeEnvironment.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default String
    getComputeEnvironmentArn()
    The ARN of this compute environment.
    default String
    getComputeEnvironmentName()
    The name of the ComputeEnvironment.
    default Boolean
    getEnabled()
    Whether or not this ComputeEnvironment can accept jobs from a Queue.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default software.constructs.Node
    getNode()
    The tree node.
    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 Stack
    getStack()
    The stack in which this resource is defined.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      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 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 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

    • getComputeEnvironmentName

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

    • 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

    • 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

    • 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 IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.