1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. ClusterSchedulerConfig

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::SageMaker::ClusterSchedulerConfig. Cluster policy configuration used for task prioritization and fair-share allocation of idle compute.

    Create ClusterSchedulerConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterSchedulerConfig(name: string, args: ClusterSchedulerConfigArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterSchedulerConfig(resource_name: str,
                               args: ClusterSchedulerConfigArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClusterSchedulerConfig(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               cluster_arn: Optional[str] = None,
                               scheduler_config: Optional[ClusterSchedulerConfigSchedulerConfigArgs] = None,
                               description: Optional[str] = None,
                               name: Optional[str] = None,
                               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewClusterSchedulerConfig(ctx *Context, name string, args ClusterSchedulerConfigArgs, opts ...ResourceOption) (*ClusterSchedulerConfig, error)
    public ClusterSchedulerConfig(string name, ClusterSchedulerConfigArgs args, CustomResourceOptions? opts = null)
    public ClusterSchedulerConfig(String name, ClusterSchedulerConfigArgs args)
    public ClusterSchedulerConfig(String name, ClusterSchedulerConfigArgs args, CustomResourceOptions options)
    
    type: aws-native:sagemaker:ClusterSchedulerConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_sagemaker_cluster_scheduler_config" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ClusterSchedulerConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterSchedulerConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterSchedulerConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterSchedulerConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterSchedulerConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClusterSchedulerConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClusterSchedulerConfig resource accepts the following input properties:

    ClusterArn string
    ARN of the cluster.
    SchedulerConfig Pulumi.AwsNative.SageMaker.Inputs.ClusterSchedulerConfigSchedulerConfig
    Description string
    Description of the cluster policy.
    Name string
    Name for the cluster policy.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags of the cluster policy.
    ClusterArn string
    ARN of the cluster.
    SchedulerConfig ClusterSchedulerConfigSchedulerConfigArgs
    Description string
    Description of the cluster policy.
    Name string
    Name for the cluster policy.
    Tags TagArgs
    Tags of the cluster policy.
    cluster_arn string
    ARN of the cluster.
    scheduler_config object
    description string
    Description of the cluster policy.
    name string
    Name for the cluster policy.
    tags list(object)
    Tags of the cluster policy.
    clusterArn String
    ARN of the cluster.
    schedulerConfig ClusterSchedulerConfigSchedulerConfig
    description String
    Description of the cluster policy.
    name String
    Name for the cluster policy.
    tags List<Tag>
    Tags of the cluster policy.
    clusterArn string
    ARN of the cluster.
    schedulerConfig ClusterSchedulerConfigSchedulerConfig
    description string
    Description of the cluster policy.
    name string
    Name for the cluster policy.
    tags Tag[]
    Tags of the cluster policy.
    cluster_arn str
    ARN of the cluster.
    scheduler_config ClusterSchedulerConfigSchedulerConfigArgs
    description str
    Description of the cluster policy.
    name str
    Name for the cluster policy.
    tags Sequence[TagArgs]
    Tags of the cluster policy.
    clusterArn String
    ARN of the cluster.
    schedulerConfig Property Map
    description String
    Description of the cluster policy.
    name String
    Name for the cluster policy.
    tags List<Property Map>
    Tags of the cluster policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterSchedulerConfig resource produces the following output properties:

    ClusterSchedulerConfigArn string
    ARN of the cluster policy.
    ClusterSchedulerConfigId string
    ID of the cluster policy.
    ClusterSchedulerConfigVersion int
    Version of the cluster policy.
    CreationTime string
    Creation time of the cluster policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.SageMaker.ClusterSchedulerConfigStatus
    Status of the cluster policy.
    ClusterSchedulerConfigArn string
    ARN of the cluster policy.
    ClusterSchedulerConfigId string
    ID of the cluster policy.
    ClusterSchedulerConfigVersion int
    Version of the cluster policy.
    CreationTime string
    Creation time of the cluster policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status ClusterSchedulerConfigStatus
    Status of the cluster policy.
    cluster_scheduler_config_arn string
    ARN of the cluster policy.
    cluster_scheduler_config_id string
    ID of the cluster policy.
    cluster_scheduler_config_version number
    Version of the cluster policy.
    creation_time string
    Creation time of the cluster policy.
    id string
    The provider-assigned unique ID for this managed resource.
    status "Creating" | "CreateFailed" | "CreateRollbackFailed" | "Created" | "Updating" | "UpdateFailed" | "UpdateRollbackFailed" | "Updated" | "Deleting" | "DeleteFailed" | "DeleteRollbackFailed" | "Deleted"
    Status of the cluster policy.
    clusterSchedulerConfigArn String
    ARN of the cluster policy.
    clusterSchedulerConfigId String
    ID of the cluster policy.
    clusterSchedulerConfigVersion Integer
    Version of the cluster policy.
    creationTime String
    Creation time of the cluster policy.
    id String
    The provider-assigned unique ID for this managed resource.
    status ClusterSchedulerConfigStatus
    Status of the cluster policy.
    clusterSchedulerConfigArn string
    ARN of the cluster policy.
    clusterSchedulerConfigId string
    ID of the cluster policy.
    clusterSchedulerConfigVersion number
    Version of the cluster policy.
    creationTime string
    Creation time of the cluster policy.
    id string
    The provider-assigned unique ID for this managed resource.
    status ClusterSchedulerConfigStatus
    Status of the cluster policy.
    cluster_scheduler_config_arn str
    ARN of the cluster policy.
    cluster_scheduler_config_id str
    ID of the cluster policy.
    cluster_scheduler_config_version int
    Version of the cluster policy.
    creation_time str
    Creation time of the cluster policy.
    id str
    The provider-assigned unique ID for this managed resource.
    status ClusterSchedulerConfigStatus
    Status of the cluster policy.
    clusterSchedulerConfigArn String
    ARN of the cluster policy.
    clusterSchedulerConfigId String
    ID of the cluster policy.
    clusterSchedulerConfigVersion Number
    Version of the cluster policy.
    creationTime String
    Creation time of the cluster policy.
    id String
    The provider-assigned unique ID for this managed resource.
    status "Creating" | "CreateFailed" | "CreateRollbackFailed" | "Created" | "Updating" | "UpdateFailed" | "UpdateRollbackFailed" | "Updated" | "Deleting" | "DeleteFailed" | "DeleteRollbackFailed" | "Deleted"
    Status of the cluster policy.

    Look up Existing ClusterSchedulerConfig Resource

    Get an existing ClusterSchedulerConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): ClusterSchedulerConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> ClusterSchedulerConfig
    func GetClusterSchedulerConfig(ctx *Context, name string, id IDInput, state *ClusterSchedulerConfigState, opts ...ResourceOption) (*ClusterSchedulerConfig, error)
    public static ClusterSchedulerConfig Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static ClusterSchedulerConfig get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingClusterSchedulerConfig:    type: aws-native:sagemaker:ClusterSchedulerConfig    get:      id: ${id}
    import {
      to = aws-native_sagemaker_cluster_scheduler_config.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state ClusterSchedulerConfigState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    ClusterSchedulerConfigPriorityClass, ClusterSchedulerConfigPriorityClassArgs

    Priority class configuration.

    Name string
    Name of the priority class.
    Weight int
    Weight of the priority class. Range 0-100, default 0.
    Name string
    Name of the priority class.
    Weight int
    Weight of the priority class. Range 0-100, default 0.
    name string
    Name of the priority class.
    weight number
    Weight of the priority class. Range 0-100, default 0.
    name String
    Name of the priority class.
    weight Integer
    Weight of the priority class. Range 0-100, default 0.
    name string
    Name of the priority class.
    weight number
    Weight of the priority class. Range 0-100, default 0.
    name str
    Name of the priority class.
    weight int
    Weight of the priority class. Range 0-100, default 0.
    name String
    Name of the priority class.
    weight Number
    Weight of the priority class. Range 0-100, default 0.

    ClusterSchedulerConfigSchedulerConfig, ClusterSchedulerConfigSchedulerConfigArgs

    Cluster policy configuration.

    FairShare Pulumi.AwsNative.SageMaker.ClusterSchedulerConfigSchedulerConfigFairShare
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    IdleResourceSharing Pulumi.AwsNative.SageMaker.ClusterSchedulerConfigSchedulerConfigIdleResourceSharing
    Configuration for sharing idle compute resources across entities.
    PriorityClasses List<Pulumi.AwsNative.SageMaker.Inputs.ClusterSchedulerConfigPriorityClass>
    List of priority class configurations.
    FairShare ClusterSchedulerConfigSchedulerConfigFairShare
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    IdleResourceSharing ClusterSchedulerConfigSchedulerConfigIdleResourceSharing
    Configuration for sharing idle compute resources across entities.
    PriorityClasses []ClusterSchedulerConfigPriorityClass
    List of priority class configurations.
    fair_share "Enabled" | "Disabled"
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    idle_resource_sharing "Enabled" | "Disabled"
    Configuration for sharing idle compute resources across entities.
    priority_classes list(object)
    List of priority class configurations.
    fairShare ClusterSchedulerConfigSchedulerConfigFairShare
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    idleResourceSharing ClusterSchedulerConfigSchedulerConfigIdleResourceSharing
    Configuration for sharing idle compute resources across entities.
    priorityClasses List<ClusterSchedulerConfigPriorityClass>
    List of priority class configurations.
    fairShare ClusterSchedulerConfigSchedulerConfigFairShare
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    idleResourceSharing ClusterSchedulerConfigSchedulerConfigIdleResourceSharing
    Configuration for sharing idle compute resources across entities.
    priorityClasses ClusterSchedulerConfigPriorityClass[]
    List of priority class configurations.
    fair_share ClusterSchedulerConfigSchedulerConfigFairShare
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    idle_resource_sharing ClusterSchedulerConfigSchedulerConfigIdleResourceSharing
    Configuration for sharing idle compute resources across entities.
    priority_classes Sequence[ClusterSchedulerConfigPriorityClass]
    List of priority class configurations.
    fairShare "Enabled" | "Disabled"
    When enabled, entities borrow idle compute based on assigned FairShareWeight.
    idleResourceSharing "Enabled" | "Disabled"
    Configuration for sharing idle compute resources across entities.
    priorityClasses List<Property Map>
    List of priority class configurations.

    ClusterSchedulerConfigSchedulerConfigFairShare

    When enabled, entities borrow idle compute based on assigned FairShareWeight.

    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    ClusterSchedulerConfigSchedulerConfigFairShareEnabledEnabled
    ClusterSchedulerConfigSchedulerConfigFairShareDisabledDisabled
    Value
    Enabled
    Disabled
    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    ENABLEDEnabled
    DISABLEDDisabled
    Value
    Enabled
    Disabled

    ClusterSchedulerConfigSchedulerConfigIdleResourceSharing

    Configuration for sharing idle compute resources across entities.

    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    ClusterSchedulerConfigSchedulerConfigIdleResourceSharingEnabledEnabled
    ClusterSchedulerConfigSchedulerConfigIdleResourceSharingDisabledDisabled
    Value
    Enabled
    Disabled
    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    EnabledEnabled
    DisabledDisabled
    NameValue
    ENABLEDEnabled
    DISABLEDDisabled
    Value
    Enabled
    Disabled

    ClusterSchedulerConfigStatus

    Status of the cluster policy.

    NameValue
    CreatingCreating
    CreateFailedCreateFailed
    CreateRollbackFailedCreateRollbackFailed
    CreatedCreated
    UpdatingUpdating
    UpdateFailedUpdateFailed
    UpdateRollbackFailedUpdateRollbackFailed
    UpdatedUpdated
    DeletingDeleting
    DeleteFailedDeleteFailed
    DeleteRollbackFailedDeleteRollbackFailed
    DeletedDeleted
    NameValue
    ClusterSchedulerConfigStatusCreatingCreating
    ClusterSchedulerConfigStatusCreateFailedCreateFailed
    ClusterSchedulerConfigStatusCreateRollbackFailedCreateRollbackFailed
    ClusterSchedulerConfigStatusCreatedCreated
    ClusterSchedulerConfigStatusUpdatingUpdating
    ClusterSchedulerConfigStatusUpdateFailedUpdateFailed
    ClusterSchedulerConfigStatusUpdateRollbackFailedUpdateRollbackFailed
    ClusterSchedulerConfigStatusUpdatedUpdated
    ClusterSchedulerConfigStatusDeletingDeleting
    ClusterSchedulerConfigStatusDeleteFailedDeleteFailed
    ClusterSchedulerConfigStatusDeleteRollbackFailedDeleteRollbackFailed
    ClusterSchedulerConfigStatusDeletedDeleted
    Value
    Creating
    CreateFailed
    CreateRollbackFailed
    Created
    Updating
    UpdateFailed
    UpdateRollbackFailed
    Updated
    Deleting
    DeleteFailed
    DeleteRollbackFailed
    Deleted
    NameValue
    CreatingCreating
    CreateFailedCreateFailed
    CreateRollbackFailedCreateRollbackFailed
    CreatedCreated
    UpdatingUpdating
    UpdateFailedUpdateFailed
    UpdateRollbackFailedUpdateRollbackFailed
    UpdatedUpdated
    DeletingDeleting
    DeleteFailedDeleteFailed
    DeleteRollbackFailedDeleteRollbackFailed
    DeletedDeleted
    NameValue
    CreatingCreating
    CreateFailedCreateFailed
    CreateRollbackFailedCreateRollbackFailed
    CreatedCreated
    UpdatingUpdating
    UpdateFailedUpdateFailed
    UpdateRollbackFailedUpdateRollbackFailed
    UpdatedUpdated
    DeletingDeleting
    DeleteFailedDeleteFailed
    DeleteRollbackFailedDeleteRollbackFailed
    DeletedDeleted
    NameValue
    CREATINGCreating
    CREATE_FAILEDCreateFailed
    CREATE_ROLLBACK_FAILEDCreateRollbackFailed
    CREATEDCreated
    UPDATINGUpdating
    UPDATE_FAILEDUpdateFailed
    UPDATE_ROLLBACK_FAILEDUpdateRollbackFailed
    UPDATEDUpdated
    DELETINGDeleting
    DELETE_FAILEDDeleteFailed
    DELETE_ROLLBACK_FAILEDDeleteRollbackFailed
    DELETEDDeleted
    Value
    Creating
    CreateFailed
    CreateRollbackFailed
    Created
    Updating
    UpdateFailed
    UpdateRollbackFailed
    Updated
    Deleting
    DeleteFailed
    DeleteRollbackFailed
    Deleted

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial