Interface ICfnNotebookInstanceProps
Properties for defining a CfnNotebookInstance
.
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public interface ICfnNotebookInstanceProps
Syntax (vb)
Public Interface ICfnNotebookInstanceProps
Remarks
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 cfnNotebookInstanceProps = new CfnNotebookInstanceProps {
InstanceType = "instanceType",
RoleArn = "roleArn",
// the properties below are optional
AcceleratorTypes = new [] { "acceleratorTypes" },
AdditionalCodeRepositories = new [] { "additionalCodeRepositories" },
DefaultCodeRepository = "defaultCodeRepository",
DirectInternetAccess = "directInternetAccess",
InstanceMetadataServiceConfiguration = new InstanceMetadataServiceConfigurationProperty {
MinimumInstanceMetadataServiceVersion = "minimumInstanceMetadataServiceVersion"
},
KmsKeyId = "kmsKeyId",
LifecycleConfigName = "lifecycleConfigName",
NotebookInstanceName = "notebookInstanceName",
PlatformIdentifier = "platformIdentifier",
RootAccess = "rootAccess",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetId = "subnetId",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VolumeSizeInGb = 123
};
Synopsis
Properties
AcceleratorTypes | A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. |
AdditionalCodeRepositories | An array of up to three Git repositories associated with the notebook instance. |
DefaultCodeRepository | The Git repository associated with the notebook instance as its default code repository. |
DirectInternetAccess | Sets whether SageMaker provides internet access to the notebook instance. |
InstanceMetadataServiceConfiguration | Information on the IMDS configuration of the notebook instance. |
InstanceType | The type of ML compute instance to launch for the notebook instance. |
KmsKeyId | The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. |
LifecycleConfigName | The name of a lifecycle configuration to associate with the notebook instance. |
NotebookInstanceName | The name of the new notebook instance. |
PlatformIdentifier | The platform identifier of the notebook instance runtime environment. |
RoleArn | When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. |
RootAccess | Whether root access is enabled or disabled for users of the notebook instance. The default value is |
SecurityGroupIds | The VPC security group IDs, in the form sg-xxxxxxxx. |
SubnetId | The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. |
Tags | A list of key-value pairs to apply to this resource. |
VolumeSizeInGb | The size, in GB, of the ML storage volume to attach to the notebook instance. |
Properties
AcceleratorTypes
A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
virtual string[] AcceleratorTypes { get; }
Property Value
System.String[]
Remarks
Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker .
Valid Values: ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge
.
AdditionalCodeRepositories
An array of up to three Git repositories associated with the notebook instance.
virtual string[] AdditionalCodeRepositories { get; }
Property Value
System.String[]
Remarks
These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances .
DefaultCodeRepository
The Git repository associated with the notebook instance as its default code repository.
virtual string DefaultCodeRepository { get; }
Property Value
System.String
Remarks
This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances .
DirectInternetAccess
Sets whether SageMaker provides internet access to the notebook instance.
virtual string DirectInternetAccess { get; }
Property Value
System.String
Remarks
If you set this to Disabled
this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled by Default . You can set the value of this parameter to Disabled
only if you set a value for the SubnetId
parameter.
InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance.
virtual object InstanceMetadataServiceConfiguration { get; }
Property Value
System.Object
Remarks
InstanceType
The type of ML compute instance to launch for the notebook instance.
string InstanceType { get; }
Property Value
System.String
Remarks
Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.
KmsKeyId
The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
virtual string KmsKeyId { get; }
Property Value
System.String
Remarks
The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide .
LifecycleConfigName
The name of a lifecycle configuration to associate with the notebook instance.
virtual string LifecycleConfigName { get; }
Property Value
System.String
Remarks
For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .
NotebookInstanceName
The name of the new notebook instance.
virtual string NotebookInstanceName { get; }
Property Value
System.String
Remarks
PlatformIdentifier
The platform identifier of the notebook instance runtime environment.
virtual string PlatformIdentifier { get; }
Property Value
System.String
Remarks
RoleArn
When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
string RoleArn { get; }
Property Value
System.String
Remarks
You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles .
To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole
permission.
RootAccess
Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled
.
virtual string RootAccess { get; }
Property Value
System.String
Remarks
Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
SecurityGroupIds
The VPC security group IDs, in the form sg-xxxxxxxx.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
The security groups must be for the same VPC as specified in the subnet.
SubnetId
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
virtual string SubnetId { get; }
Property Value
System.String
Remarks
Tags
A list of key-value pairs to apply to this resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
For more information, see Resource Tag and Using Cost Allocation Tags .
You can add tags later by using the CreateTags
API.
VolumeSizeInGb
The size, in GB, of the ML storage volume to attach to the notebook instance.
virtual Nullable<double> VolumeSizeInGb { get; }
Property Value
System.Nullable<System.Double>
Remarks
The default value is 5 GB.
Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.