Package software.amazon.awscdk.services.batch

Class IFairshareSchedulingPolicy.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.IFairshareSchedulingPolicy.Jsii$Proxy

All Implemented Interfaces:

IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IFairshareSchedulingPolicy, IFairshareSchedulingPolicy.Jsii$Default, ISchedulingPolicy, ISchedulingPolicy.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IFairshareSchedulingPolicy

@Internal
public static final class IFairshareSchedulingPolicy.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IFairshareSchedulingPolicy.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

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

IFairshareSchedulingPolicy.Jsii$Default, IFairshareSchedulingPolicy.Jsii$Proxy

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

IResource.Jsii$Default, IResource.Jsii$Proxy

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

ISchedulingPolicy.Jsii$Default, ISchedulingPolicy.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final Number	getComputeReservation()	Used to calculate the percentage of the maximum available vCPU to reserve for share identifiers not present in the Queue.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final software.constructs.Node	getNode()	The tree node.
final String	getSchedulingPolicyArn()	The arn of this scheduling policy.
final String	getSchedulingPolicyName()	The name of this scheduling policy.
final Duration	getShareDecay()	The amount of time to use to measure the usage of each job.
final List<Share>	getShares()	The shares that this Scheduling Policy applies to.
final Stack	getStack()	The stack in which this resource is defined.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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 IFairshareSchedulingPolicy.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface ISchedulingPolicy.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IFairshareSchedulingPolicy.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface ISchedulingPolicy.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IFairshareSchedulingPolicy.Jsii$Default

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
public final String getSchedulingPolicyArn()

The arn of this scheduling policy.

Specified by:

getSchedulingPolicyArn in interface IFairshareSchedulingPolicy.Jsii$Default

Specified by:

getSchedulingPolicyArn in interface ISchedulingPolicy

Specified by:

getSchedulingPolicyArn in interface ISchedulingPolicy.Jsii$Default

getSchedulingPolicyName

@Stability(Stable)
@NotNull
public final String getSchedulingPolicyName()

The name of this scheduling policy.

Specified by:

getSchedulingPolicyName in interface IFairshareSchedulingPolicy.Jsii$Default

Specified by:

getSchedulingPolicyName in interface ISchedulingPolicy

Specified by:

getSchedulingPolicyName in interface ISchedulingPolicy.Jsii$Default

getShares

@Stability(Stable)
@NotNull
public final 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

Specified by:

getShares in interface IFairshareSchedulingPolicy.Jsii$Default

getComputeReservation

@Stability(Stable)
@Nullable
public final 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

Specified by:

getComputeReservation in interface IFairshareSchedulingPolicy.Jsii$Default

getShareDecay

@Stability(Stable)
@Nullable
public final 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

Specified by:

getShareDecay in interface IFairshareSchedulingPolicy.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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 IFairshareSchedulingPolicy.Jsii$Default

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.