Interface ICfnClusterProps

Properties for defining a CfnCluster.

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnClusterProps

Syntax (vb)

Public Interface ICfnClusterProps

Remarks

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

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 cfnClusterProps = 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

Properties

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.

Properties

ClusterName

The name of the SageMaker HyperPod cluster.

virtual string ClusterName { get; }

Property Value

System.String

Remarks

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

InstanceGroups

The instance groups of the SageMaker HyperPod cluster.

object InstanceGroups { get; }

Property Value

System.Object

Remarks

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

NodeRecovery

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

virtual string NodeRecovery { get; }

Property Value

System.String

Remarks

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.

virtual object Orchestrator { get; }

Property Value

System.Object

Remarks

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

Tags

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

virtual ICfnTag[] Tags { get; }

Property Value

ICfnTag[]

Remarks

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

VpcConfig

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

virtual object VpcConfig { get; }

Property Value

System.Object

Remarks

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