Package software.amazon.awscdk.services.batch

Class CfnSchedulingPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.batch.CfnSchedulingPolicy
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:47.646Z") @Stability(Stable) public class CfnSchedulingPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::Batch::SchedulingPolicy.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnSchedulingPolicy

      @Stability(Stable) public CfnSchedulingPolicy(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags that you apply to the scheduling policy to help you categorize and organize your resources.

      Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference .

      These tags can be updated or removed using the TagResource and UntagResource API operations.

    • getFairsharePolicy

      @Stability(Stable) @Nullable public Object getFairsharePolicy()
      The fair share policy of the scheduling policy.

    • setFairsharePolicy

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

    • setFairsharePolicy

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

    • getName

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

      It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

    • setName

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

      It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).