interface CfnClusterProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Sagemaker.CfnClusterProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnClusterProps |
![]() | software.amazon.awscdk.services.sagemaker.CfnClusterProps |
![]() | aws_cdk.aws_sagemaker.CfnClusterProps |
![]() | aws-cdk-lib » aws_sagemaker » CfnClusterProps |
Properties for defining a CfnCluster
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnClusterProps: sagemaker.CfnClusterProps = {
instanceGroups: [{
executionRole: 'executionRole',
instanceCount: 123,
instanceGroupName: 'instanceGroupName',
instanceType: 'instanceType',
lifeCycleConfig: {
onCreate: 'onCreate',
sourceS3Uri: 'sourceS3Uri',
},
// the properties below are optional
currentCount: 123,
instanceStorageConfigs: [{
ebsVolumeConfig: {
volumeSizeInGb: 123,
},
}],
onStartDeepHealthChecks: ['onStartDeepHealthChecks'],
overrideVpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
},
threadsPerCore: 123,
}],
// the properties below are optional
clusterName: 'clusterName',
nodeRecovery: 'nodeRecovery',
orchestrator: {
eks: {
clusterArn: 'clusterArn',
},
},
tags: [{
key: 'key',
value: 'value',
}],
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
},
};
Properties
Name | Type | Description |
---|---|---|
instance | IResolvable | IResolvable | Cluster [] | The instance groups of the SageMaker HyperPod cluster. |
cluster | string | The name of the SageMaker HyperPod cluster. |
node | string | Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. |
orchestrator? | IResolvable | Orchestrator | The orchestrator type for the SageMaker HyperPod cluster. |
tags? | Cfn [] | A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources. |
vpc | IResolvable | Vpc | Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. |
instanceGroups
Type:
IResolvable
|
IResolvable
|
Cluster
[]
The instance groups of the SageMaker HyperPod cluster.
clusterName?
Type:
string
(optional)
The name of the SageMaker HyperPod cluster.
nodeRecovery?
Type:
string
(optional)
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?
Type:
IResolvable
|
Orchestrator
(optional)
The orchestrator type for the SageMaker HyperPod cluster.
Currently, 'eks'
is the only available option.
tags?
Type:
Cfn
[]
(optional)
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 .
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
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 .