CfnClusterProps
- class aws_cdk.aws_sagemaker.CfnClusterProps(*, instance_groups, cluster_name=None, node_recovery=None, orchestrator=None, tags=None, vpc_config=None)
Bases:
object
Properties for defining a
CfnCluster
.- Parameters:
instance_groups (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ClusterInstanceGroupProperty
,Dict
[str
,Any
]]]]) – The instance groups of the SageMaker HyperPod cluster.cluster_name (
Optional
[str
]) – The name of the SageMaker HyperPod cluster.node_recovery (
Optional
[str
]) – Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. Available values areAutomatic
for enabling andNone
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.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( 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, instance_storage_configs=[sagemaker.CfnCluster.ClusterInstanceStorageConfigProperty( ebs_volume_config=sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty( volume_size_in_gb=123 ) )], on_start_deep_health_checks=["onStartDeepHealthChecks"], threads_per_core=123 )], # the properties below are optional cluster_name="clusterName", node_recovery="nodeRecovery", orchestrator=sagemaker.CfnCluster.OrchestratorProperty( eks=sagemaker.CfnCluster.ClusterOrchestratorEksConfigProperty( cluster_arn="clusterArn" ) ), 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.
- instance_groups
The instance groups of the SageMaker HyperPod cluster.
- node_recovery
Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.
Available values are
Automatic
for enabling andNone
for disabling.
- orchestrator
The orchestrator type for the SageMaker HyperPod cluster.
Currently,
'eks'
is the only available option.
- 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 .
- 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 .