Class CfnCluster

Creates a SageMaker HyperPod cluster.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnCluster
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnCluster
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide .

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

CloudformationResource: AWS::SageMaker::Cluster

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
    InstanceGroups = new [] { new ClusterInstanceGroupProperty {
        ExecutionRole = "executionRole",
        InstanceCount = 123,
        InstanceGroupName = "instanceGroupName",
        InstanceType = "instanceType",
        LifeCycleConfig = new ClusterLifeCycleConfigProperty {
            OnCreate = "onCreate",
            SourceS3Uri = "sourceS3Uri"
        },

        // the properties below are optional
        CurrentCount = 123,
        InstanceStorageConfigs = new [] { new ClusterInstanceStorageConfigProperty {
            EbsVolumeConfig = new ClusterEbsVolumeConfigProperty {
                VolumeSizeInGb = 123
            }
        } },
        OnStartDeepHealthChecks = new [] { "onStartDeepHealthChecks" },
        OverrideVpcConfig = new VpcConfigProperty {
            SecurityGroupIds = new [] { "securityGroupIds" },
            Subnets = new [] { "subnets" }
        },
        ThreadsPerCore = 123
    } },

    // the properties below are optional
    ClusterName = "clusterName",
    NodeRecovery = "nodeRecovery",
    Orchestrator = new OrchestratorProperty {
        Eks = new ClusterOrchestratorEksConfigProperty {
            ClusterArn = "clusterArn"
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VpcConfig = new VpcConfigProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        Subnets = new [] { "subnets" }
    }
});

Synopsis

Constructors

CfnCluster(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnCluster(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnCluster(Construct, String, ICfnClusterProps)

Properties

AttrClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
AttrClusterStatus

The status of the SageMaker HyperPod cluster.
AttrCreationTime

The time when the SageMaker HyperPod cluster is created.
AttrFailureMessage

The failure message of the SageMaker HyperPod cluster.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ClusterName

The name of the SageMaker HyperPod cluster.
InstanceGroups

The instance groups of the SageMaker HyperPod cluster.
NodeRecovery

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

The orchestrator type for the SageMaker HyperPod cluster.
Tags

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

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnCluster(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnCluster(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnCluster(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnCluster(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnCluster(Construct, String, ICfnClusterProps)

public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnClusterProps

Resource properties.

Properties

AttrClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

public virtual string AttrClusterArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ClusterArn

AttrClusterStatus

The status of the SageMaker HyperPod cluster.

public virtual string AttrClusterStatus { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ClusterStatus

AttrCreationTime

The time when the SageMaker HyperPod cluster is created.

public virtual string AttrCreationTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreationTime

AttrFailureMessage

The failure message of the SageMaker HyperPod cluster.

public virtual string AttrFailureMessage { get; }
Property Value

System.String

Remarks

CloudformationAttribute: FailureMessage

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ClusterName

The name of the SageMaker HyperPod cluster.

public virtual string ClusterName { get; set; }
Property Value

System.String

InstanceGroups

The instance groups of the SageMaker HyperPod cluster.

public virtual object InstanceGroups { get; set; }
Property Value

System.Object

NodeRecovery

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

public virtual string NodeRecovery { get; set; }
Property Value

System.String

Orchestrator

The orchestrator type for the SageMaker HyperPod cluster.

public virtual object Orchestrator { get; set; }
Property Value

System.Object

Tags

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

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

VpcConfig

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

public virtual object VpcConfig { get; set; }
Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements