CfnClusterSchedulerConfigPropsMixin

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnClusterSchedulerConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SageMaker::ClusterSchedulerConfig.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-clusterschedulerconfig.html
CloudformationResource:: AWS::SageMaker::ClusterSchedulerConfig
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_cluster_scheduler_config_props_mixin = sagemaker.CfnClusterSchedulerConfigPropsMixin(sagemaker.CfnClusterSchedulerConfigMixinProps(
    cluster_arn="clusterArn",
    description="description",
    name="name",
    scheduler_config=sagemaker.CfnClusterSchedulerConfigPropsMixin.SchedulerConfigProperty(
        fair_share="fairShare",
        idle_resource_sharing="idleResourceSharing",
        priority_classes=[sagemaker.CfnClusterSchedulerConfigPropsMixin.PriorityClassProperty(
            name="name",
            weight=123
        )]
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SageMaker::ClusterSchedulerConfig.

Parameters:

props (Union[CfnClusterSchedulerConfigMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['clusterArn', 'description', 'name', 'schedulerConfig', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

PriorityClassProperty

class CfnClusterSchedulerConfigPropsMixin.PriorityClassProperty(*, name=None, weight=None)

Bases: object

Priority class configuration.

Parameters:

name (Optional[str]) – Name of the priority class.
weight (Union[int, float, None]) – Weight of the priority class. Range 0-100, default 0.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-priorityclass.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

priority_class_property = sagemaker.CfnClusterSchedulerConfigPropsMixin.PriorityClassProperty(
    name="name",
    weight=123
)

Attributes

name

Name of the priority class.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-priorityclass.html#cfn-sagemaker-clusterschedulerconfig-priorityclass-name

weight

Weight of the priority class.

Range 0-100, default 0.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-priorityclass.html#cfn-sagemaker-clusterschedulerconfig-priorityclass-weight

SchedulerConfigProperty

class CfnClusterSchedulerConfigPropsMixin.SchedulerConfigProperty(*, fair_share=None, idle_resource_sharing=None, priority_classes=None)

Bases: object

Cluster policy configuration.

Parameters:

fair_share (Optional[str]) – When enabled, entities borrow idle compute based on assigned FairShareWeight.
idle_resource_sharing (Optional[str]) – Configuration for sharing idle compute resources across entities.
priority_classes (Union[IResolvable, Sequence[Union[IResolvable, PriorityClassProperty, Dict[str, Any]]], None]) – List of priority class configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-schedulerconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

scheduler_config_property = sagemaker.CfnClusterSchedulerConfigPropsMixin.SchedulerConfigProperty(
    fair_share="fairShare",
    idle_resource_sharing="idleResourceSharing",
    priority_classes=[sagemaker.CfnClusterSchedulerConfigPropsMixin.PriorityClassProperty(
        name="name",
        weight=123
    )]
)

Attributes

fair_share

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-schedulerconfig.html#cfn-sagemaker-clusterschedulerconfig-schedulerconfig-fairshare

idle_resource_sharing

Configuration for sharing idle compute resources across entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-schedulerconfig.html#cfn-sagemaker-clusterschedulerconfig-schedulerconfig-idleresourcesharing

priority_classes

List of priority class configurations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-clusterschedulerconfig-schedulerconfig.html#cfn-sagemaker-clusterschedulerconfig-schedulerconfig-priorityclasses