Package software.amazon.awscdk.services.batch

Class CfnSchedulingPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnSchedulingPolicy
All Implemented Interfaces:
IInspectable, ISchedulingPolicyRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:29.900Z") @Stability(Stable) public class CfnSchedulingPolicy extends CfnResource implements IInspectable, ISchedulingPolicyRef, ITaggable
The AWS::Batch::SchedulingPolicy resource specifies the parameters for an AWS Batch scheduling policy.

For more information, see Scheduling Policies in the ** .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 CfnSchedulingPolicy cfnSchedulingPolicy = CfnSchedulingPolicy.Builder.create(this, "MyCfnSchedulingPolicy")
         .fairsharePolicy(FairsharePolicyProperty.builder()
                 .computeReservation(123)
                 .shareDecaySeconds(123)
                 .shareDistribution(List.of(ShareAttributesProperty.builder()
                         .shareIdentifier("shareIdentifier")
                         .weightFactor(123)
                         .build()))
                 .build())
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchedulingPolicy

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

    • CfnSchedulingPolicy

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

    • CfnSchedulingPolicy

      @Stability(Stable) public CfnSchedulingPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnSchedulingPolicyProps props)
      Create a new AWS::Batch::SchedulingPolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnSchedulingPolicy

      @Stability(Stable) public CfnSchedulingPolicy(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Batch::SchedulingPolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForSchedulingPolicy

      @Stability(Stable) @NotNull public static String arnForSchedulingPolicy(@NotNull ISchedulingPolicyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSchedulingPolicy

      @Stability(Stable) @NotNull public static Boolean isCfnSchedulingPolicy(@NotNull Object x)
      Checks whether the given object is a CfnSchedulingPolicy.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSchedulingPolicyRef

      @Stability(Stable) @NotNull public SchedulingPolicyReference getSchedulingPolicyRef()
      A reference to a SchedulingPolicy resource.
      Specified by:
      getSchedulingPolicyRef in interface ISchedulingPolicyRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getFairsharePolicy

      @Stability(Stable) @Nullable public Object getFairsharePolicy()
      The fair-share scheduling policy details.

      Returns union: either IResolvable or CfnSchedulingPolicy.FairsharePolicyProperty

    • setFairsharePolicy

      @Stability(Stable) public void setFairsharePolicy(@Nullable IResolvable value)
      The fair-share scheduling policy details.

    • setFairsharePolicy

      @Stability(Stable) public void setFairsharePolicy(@Nullable CfnSchedulingPolicy.FairsharePolicyProperty value)
      The fair-share scheduling policy details.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the fair-share scheduling policy.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the fair-share scheduling policy.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The tags that you apply to the scheduling policy to help you categorize and organize your resources.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The tags that you apply to the scheduling policy to help you categorize and organize your resources.