Package software.amazon.awscdk.services.sagemaker

Class CfnClusterSchedulerConfig

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.sagemaker.CfnClusterSchedulerConfig
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IClusterSchedulerConfigRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:05:00.609Z") @Stability(Stable) public class CfnClusterSchedulerConfig extends CfnResource implements IInspectable, IClusterSchedulerConfigRef, ITaggableV2
Resource Type definition for AWS::SageMaker::ClusterSchedulerConfig.

Cluster policy configuration used for task prioritization and fair-share allocation of idle compute.

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.sagemaker.*;
 CfnClusterSchedulerConfig cfnClusterSchedulerConfig = CfnClusterSchedulerConfig.Builder.create(this, "MyCfnClusterSchedulerConfig")
         .clusterArn("clusterArn")
         .name("name")
         .schedulerConfig(SchedulerConfigProperty.builder()
                 .fairShare("fairShare")
                 .idleResourceSharing("idleResourceSharing")
                 .priorityClasses(List.of(PriorityClassProperty.builder()
                         .name("name")
                         .weight(123)
                         .build()))
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnClusterSchedulerConfig

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

    • CfnClusterSchedulerConfig

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

    • CfnClusterSchedulerConfig

      @Stability(Stable) public CfnClusterSchedulerConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterSchedulerConfigProps props)
      Create a new AWS::SageMaker::ClusterSchedulerConfig.

      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. This parameter is required.

  • Method Details

    • arnForClusterSchedulerConfig

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

    • isCfnClusterSchedulerConfig

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

      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.

    • getAttrClusterSchedulerConfigArn

      @Stability(Stable) @NotNull public String getAttrClusterSchedulerConfigArn()
      ARN of the cluster policy.

    • getAttrClusterSchedulerConfigId

      @Stability(Stable) @NotNull public String getAttrClusterSchedulerConfigId()
      ID of the cluster policy.

    • getAttrClusterSchedulerConfigVersion

      @Stability(Stable) @NotNull public Number getAttrClusterSchedulerConfigVersion()
      Version of the cluster policy.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      Creation time of the cluster policy.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status of the cluster policy.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getClusterSchedulerConfigRef

      @Stability(Stable) @NotNull public ClusterSchedulerConfigReference getClusterSchedulerConfigRef()
      A reference to a ClusterSchedulerConfig resource.
      Specified by:
      getClusterSchedulerConfigRef in interface IClusterSchedulerConfigRef

    • getClusterArn

      @Stability(Stable) @NotNull public String getClusterArn()
      ARN of the cluster.

    • setClusterArn

      @Stability(Stable) public void setClusterArn(@NotNull String value)
      ARN of the cluster.

    • getName

      @Stability(Stable) @NotNull public String getName()
      Name for the cluster policy.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      Name for the cluster policy.

    • getSchedulerConfig

      @Stability(Stable) @NotNull public Object getSchedulerConfig()
      Cluster policy configuration.

      Returns union: either IResolvable or CfnClusterSchedulerConfig.SchedulerConfigProperty

    • setSchedulerConfig

      @Stability(Stable) public void setSchedulerConfig(@NotNull IResolvable value)
      Cluster policy configuration.

    • setSchedulerConfig

      @Stability(Stable) public void setSchedulerConfig(@NotNull CfnClusterSchedulerConfig.SchedulerConfigProperty value)
      Cluster policy configuration.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Description of the cluster policy.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Description of the cluster policy.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags of the cluster policy.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags of the cluster policy.