Package software.amazon.awscdk.services.batch

Interface IFairshareSchedulingPolicy.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IFairshareSchedulingPolicy, IResource, IResource.Jsii$Default, ISchedulingPolicy, ISchedulingPolicy.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IFairshareSchedulingPolicy.Jsii$Proxy
Enclosing interface:
IFairshareSchedulingPolicy
@Internal public static interface IFairshareSchedulingPolicy.Jsii$Default extends IFairshareSchedulingPolicy, ISchedulingPolicy.Jsii$Default
Internal default implementation for IFairshareSchedulingPolicy.

  • 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
      Specified by:
      getNode in interface ISchedulingPolicy.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
      Specified by:
      getEnv in interface ISchedulingPolicy.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
      Specified by:
      getStack in interface ISchedulingPolicy.Jsii$Default

    • getSchedulingPolicyArn

      @Stability(Stable) @NotNull default String getSchedulingPolicyArn()
      The arn of this scheduling policy.
      Specified by:
      getSchedulingPolicyArn in interface ISchedulingPolicy
      Specified by:
      getSchedulingPolicyArn in interface ISchedulingPolicy.Jsii$Default

    • getSchedulingPolicyName

      @Stability(Stable) @NotNull default String getSchedulingPolicyName()
      The name of this scheduling policy.
      Specified by:
      getSchedulingPolicyName in interface ISchedulingPolicy
      Specified by:
      getSchedulingPolicyName in interface ISchedulingPolicy.Jsii$Default

    • getShares

      @Stability(Stable) @NotNull default List<Share> getShares()
      The shares that this Scheduling Policy applies to.

      Note: It is possible to submit Jobs to the queue with Share Identifiers that are not recognized by the Scheduling Policy.

      Specified by:
      getShares in interface IFairshareSchedulingPolicy

    • getComputeReservation

      @Stability(Stable) @Nullable default Number getComputeReservation()
      Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.

      The percentage reserved is defined by the Scheduler as: (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

      For example, a computeReservation value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers.

      A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

      Default: - no vCPU is reserved

      Specified by:
      getComputeReservation in interface IFairshareSchedulingPolicy

    • getShareDecay

      @Stability(Stable) @Nullable default Duration getShareDecay()
      The amount of time to use to measure the usage of each job.

      The usage is used to calculate a fair share percentage for each fair share identifier currently in the Queue. A value of zero (0) indicates that only current usage is measured. The decay is linear and gives preference to newer jobs.

      The maximum supported value is 604800 seconds (1 week).

      Default: - 0: only the current job usage is considered

      Specified by:
      getShareDecay in interface IFairshareSchedulingPolicy

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