CfnClusterProps

class aws_cdk.aws_sagemaker.CfnClusterProps(*, cluster_name=None, instance_groups=None, node_provisioning_mode=None, node_recovery=None, orchestrator=None, restricted_instance_groups=None, tags=None, vpc_config=None)

Bases: object

Properties for defining a CfnCluster.

Parameters:

cluster_name (Optional[str]) – The name of the SageMaker HyperPod cluster.
instance_groups (Union[IResolvable, Sequence[Union[IResolvable, ClusterInstanceGroupProperty, Dict[str, Any]]], None]) – The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.
node_provisioning_mode (Optional[str]) – Determines the scaling strategy for the SageMaker HyperPod cluster. When set to ‘Continuous’, enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.
node_recovery (Optional[str]) – Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values are Automatic for enabling and None for disabling.
orchestrator (Union[IResolvable, OrchestratorProperty, Dict[str, Any], None]) – The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.
restricted_instance_groups (Union[IResolvable, Sequence[Union[IResolvable, ClusterRestrictedInstanceGroupProperty, Dict[str, Any]]], None]) – The restricted instance groups of the SageMaker HyperPod cluster.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags . For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources . For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy .
vpc_config (Union[IResolvable, VpcConfigProperty, Dict[str, Any], None]) – Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.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 import aws_sagemaker as sagemaker

cfn_cluster_props = sagemaker.CfnClusterProps(
    cluster_name="clusterName",
    instance_groups=[sagemaker.CfnCluster.ClusterInstanceGroupProperty(
        execution_role="executionRole",
        instance_count=123,
        instance_group_name="instanceGroupName",
        instance_type="instanceType",
        life_cycle_config=sagemaker.CfnCluster.ClusterLifeCycleConfigProperty(
            on_create="onCreate",
            source_s3_uri="sourceS3Uri"
        ),

        # the properties below are optional
        current_count=123,
        image_id="imageId",
        instance_storage_configs=[sagemaker.CfnCluster.ClusterInstanceStorageConfigProperty(
            ebs_volume_config=sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty(
                volume_size_in_gb=123
            )
        )],
        on_start_deep_health_checks=["onStartDeepHealthChecks"],
        override_vpc_config=sagemaker.CfnCluster.VpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnets=["subnets"]
        ),
        scheduled_update_config=sagemaker.CfnCluster.ScheduledUpdateConfigProperty(
            schedule_expression="scheduleExpression",

            # the properties below are optional
            deployment_config=sagemaker.CfnCluster.DeploymentConfigProperty(
                auto_rollback_configuration=[sagemaker.CfnCluster.AlarmDetailsProperty(
                    alarm_name="alarmName"
                )],
                rolling_update_policy=sagemaker.CfnCluster.RollingUpdatePolicyProperty(
                    maximum_batch_size=sagemaker.CfnCluster.CapacitySizeConfigProperty(
                        type="type",
                        value=123
                    ),

                    # the properties below are optional
                    rollback_maximum_batch_size=sagemaker.CfnCluster.CapacitySizeConfigProperty(
                        type="type",
                        value=123
                    )
                ),
                wait_interval_in_seconds=123
            )
        ),
        threads_per_core=123,
        training_plan_arn="trainingPlanArn"
    )],
    node_provisioning_mode="nodeProvisioningMode",
    node_recovery="nodeRecovery",
    orchestrator=sagemaker.CfnCluster.OrchestratorProperty(
        eks=sagemaker.CfnCluster.ClusterOrchestratorEksConfigProperty(
            cluster_arn="clusterArn"
        )
    ),
    restricted_instance_groups=[sagemaker.CfnCluster.ClusterRestrictedInstanceGroupProperty(
        environment_config=sagemaker.CfnCluster.EnvironmentConfigProperty(
            f_sx_lustre_config=sagemaker.CfnCluster.FSxLustreConfigProperty(
                per_unit_storage_throughput=123,
                size_in_gi_b=123
            )
        ),
        execution_role="executionRole",
        instance_count=123,
        instance_group_name="instanceGroupName",
        instance_type="instanceType",

        # the properties below are optional
        current_count=123,
        instance_storage_configs=[sagemaker.CfnCluster.ClusterInstanceStorageConfigProperty(
            ebs_volume_config=sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty(
                volume_size_in_gb=123
            )
        )],
        on_start_deep_health_checks=["onStartDeepHealthChecks"],
        override_vpc_config=sagemaker.CfnCluster.VpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnets=["subnets"]
        ),
        threads_per_core=123,
        training_plan_arn="trainingPlanArn"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_config=sagemaker.CfnCluster.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"]
    )
)

Attributes

cluster_name

The name of the SageMaker HyperPod cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clustername

instance_groups

The instance groups of the SageMaker HyperPod cluster.

To delete an instance group, remove it from the array.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups

node_provisioning_mode

Determines the scaling strategy for the SageMaker HyperPod cluster.

When set to ‘Continuous’, enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode

node_recovery

Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.

Available values are Automatic for enabling and None for disabling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery

orchestrator

The orchestrator type for the SageMaker HyperPod cluster.

Currently, 'eks' is the only available option.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator

restricted_instance_groups

The restricted instance groups of the SageMaker HyperPod cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups

tags

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources . For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tags

vpc_config

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig