Class CfnNotebookInstance
The AWS::SageMaker::NotebookInstance
resource creates an Amazon SageMaker notebook instance.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNotebookInstance : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnNotebookInstance
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances .
CloudformationResource: AWS::SageMaker::NotebookInstance
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 cfnNotebookInstance = new CfnNotebookInstance(this, "MyCfnNotebookInstance", 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
Constructors
CfnNotebookInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnNotebookInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnNotebookInstance(Construct, String, ICfnNotebookInstanceProps) |
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. |
AttrId | |
AttrNotebookInstanceName | The name of the notebook instance, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnNotebookInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnNotebookInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnNotebookInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnNotebookInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnNotebookInstance(Construct, String, ICfnNotebookInstanceProps)
public CfnNotebookInstance(Construct scope, string id, ICfnNotebookInstanceProps 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 ICfnNotebookInstanceProps
Resource properties.
Properties
AcceleratorTypes
A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
public virtual string[] AcceleratorTypes { get; set; }
Property Value
System.String[]
AdditionalCodeRepositories
An array of up to three Git repositories associated with the notebook instance.
public virtual string[] AdditionalCodeRepositories { get; set; }
Property Value
System.String[]
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrNotebookInstanceName
The name of the notebook instance, such as MyNotebookInstance
.
public virtual string AttrNotebookInstanceName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: NotebookInstanceName
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
DefaultCodeRepository
The Git repository associated with the notebook instance as its default code repository.
public virtual string DefaultCodeRepository { get; set; }
Property Value
System.String
DirectInternetAccess
Sets whether SageMaker provides internet access to the notebook instance.
public virtual string DirectInternetAccess { get; set; }
Property Value
System.String
InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance.
public virtual object InstanceMetadataServiceConfiguration { get; set; }
Property Value
System.Object
InstanceType
The type of ML compute instance to launch for the notebook instance.
public virtual string InstanceType { get; set; }
Property Value
System.String
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.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
LifecycleConfigName
The name of a lifecycle configuration to associate with the notebook instance.
public virtual string LifecycleConfigName { get; set; }
Property Value
System.String
NotebookInstanceName
The name of the new notebook instance.
public virtual string NotebookInstanceName { get; set; }
Property Value
System.String
PlatformIdentifier
The platform identifier of the notebook instance runtime environment.
public virtual string PlatformIdentifier { get; set; }
Property Value
System.String
RoleArn
When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
public virtual string RoleArn { get; set; }
Property Value
System.String
RootAccess
Whether root access is enabled or disabled for users of the notebook instance.
public virtual string RootAccess { get; set; }
Property Value
System.String
Remarks
The default value is Enabled
.
SecurityGroupIds
The VPC security group IDs, in the form sg-xxxxxxxx.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
SubnetId
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
public virtual string SubnetId { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VolumeSizeInGb
The size, in GB, of the ML storage volume to attach to the notebook instance.
public virtual Nullable<double> VolumeSizeInGb { get; set; }
Property Value
System.Nullable<System.Double>
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>