class CfnNotebookInstance (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnNotebookInstance
Java	software.amazon.awscdk.services.sagemaker.CfnNotebookInstance
Python	aws_cdk.aws_sagemaker.CfnNotebookInstance
TypeScript	@aws-cdk/aws-sagemaker » CfnNotebookInstance

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::SageMaker::NotebookInstance.

The AWS::SageMaker::NotebookInstance resource creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
const cfnNotebookInstance = new sagemaker.CfnNotebookInstance(this, 'MyCfnNotebookInstance', {
  instanceType: 'instanceType',
  roleArn: 'roleArn',

  // the properties below are optional
  acceleratorTypes: ['acceleratorTypes'],
  additionalCodeRepositories: ['additionalCodeRepositories'],
  defaultCodeRepository: 'defaultCodeRepository',
  directInternetAccess: 'directInternetAccess',
  instanceMetadataServiceConfiguration: {
    minimumInstanceMetadataServiceVersion: 'minimumInstanceMetadataServiceVersion',
  },
  kmsKeyId: 'kmsKeyId',
  lifecycleConfigName: 'lifecycleConfigName',
  notebookInstanceName: 'notebookInstanceName',
  platformIdentifier: 'platformIdentifier',
  rootAccess: 'rootAccess',
  securityGroupIds: ['securityGroupIds'],
  subnetId: 'subnetId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  volumeSizeInGb: 123,
});

Initializer

new CfnNotebookInstance(scope: Construct, id: string, props: CfnNotebookInstanceProps)

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnNotebookInstanceProps — - resource properties.

Create a new AWS::SageMaker::NotebookInstance.

Construct Props

Name	Type	Description
instanceType	string	The type of ML compute instance to launch for the notebook instance.
roleArn	string	When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
acceleratorTypes?	string[]	A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
additionalCodeRepositories?	string[]	An array of up to three Git repositories associated with the notebook instance.
defaultCodeRepository?	string	The Git repository associated with the notebook instance as its default code repository.
directInternetAccess?	string	Sets whether SageMaker provides internet access to the notebook instance.
instanceMetadataServiceConfiguration?	IResolvable | InstanceMetadataServiceConfigurationProperty	Information on the IMDS configuration of the notebook instance.
kmsKeyId?	string	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?	string	The name of a lifecycle configuration to associate with the notebook instance.
notebookInstanceName?	string	The name of the new notebook instance.
platformIdentifier?	string	The platform identifier of the notebook instance runtime environment.
rootAccess?	string	Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled .
securityGroupIds?	string[]	The VPC security group IDs, in the form sg-xxxxxxxx.
subnetId?	string	The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
tags?	CfnTag[]	A list of key-value pairs to apply to this resource.
volumeSizeInGb?	number	The size, in GB, of the ML storage volume to attach to the notebook instance.

---

instanceType

Type: string

The type of ML compute instance to launch for the notebook instance.

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

---

roleArn

Type: string

When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.

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.

---

acceleratorTypes?

Type: string[] (optional)

A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

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?

Type: string[] (optional)

An array of up to three Git repositories associated with the notebook instance.

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?

Type: string (optional)

The Git repository associated with the notebook instance as its default code repository.

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?

Type: string (optional)

Sets whether SageMaker provides internet access to the notebook instance.

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?

Type: IResolvable | InstanceMetadataServiceConfigurationProperty (optional)

Information on the IMDS configuration of the notebook instance.

---

kmsKeyId?

Type: string (optional)

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.

The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide .

---

lifecycleConfigName?

Type: string (optional)

The name of a lifecycle configuration to associate with the notebook instance.

For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .

---

notebookInstanceName?

Type: string (optional)

The name of the new notebook instance.

---

platformIdentifier?

Type: string (optional)

The platform identifier of the notebook instance runtime environment.

---

rootAccess?

Type: string (optional)

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled .

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?

Type: string[] (optional)

The VPC security group IDs, in the form sg-xxxxxxxx.

The security groups must be for the same VPC as specified in the subnet.

---

subnetId?

Type: string (optional)

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

---

tags?

Type: CfnTag[] (optional)

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags .

You can add tags later by using the CreateTags API.

---

volumeSizeInGb?

Type: number (optional)

The size, in GB, of the ML storage volume to attach to the notebook instance.

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.

Properties

Name	Type	Description
attrNotebookInstanceName	string	The name of the notebook instance, such as MyNotebookInstance .
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
instanceType	string	The type of ML compute instance to launch for the notebook instance.
logicalId	string	The logical ID for this CloudFormation stack element.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
roleArn	string	When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
stack	Stack	The stack in which this element is defined.
tags	TagManager	A list of key-value pairs to apply to this resource.
acceleratorTypes?	string[]	A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
additionalCodeRepositories?	string[]	An array of up to three Git repositories associated with the notebook instance.
defaultCodeRepository?	string	The Git repository associated with the notebook instance as its default code repository.
directInternetAccess?	string	Sets whether SageMaker provides internet access to the notebook instance.
instanceMetadataServiceConfiguration?	IResolvable | InstanceMetadataServiceConfigurationProperty	Information on the IMDS configuration of the notebook instance.
kmsKeyId?	string	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?	string	The name of a lifecycle configuration to associate with the notebook instance.
notebookInstanceName?	string	The name of the new notebook instance.
platformIdentifier?	string	The platform identifier of the notebook instance runtime environment.
rootAccess?	string	Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled .
securityGroupIds?	string[]	The VPC security group IDs, in the form sg-xxxxxxxx.
subnetId?	string	The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
volumeSizeInGb?	number	The size, in GB, of the ML storage volume to attach to the notebook instance.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrNotebookInstanceName

Type: string

The name of the notebook instance, such as MyNotebookInstance .

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

instanceType

Type: string

The type of ML compute instance to launch for the notebook instance.

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

roleArn

Type: string

When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.

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.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags .

You can add tags later by using the CreateTags API.

---

acceleratorTypes?

Type: string[] (optional)

A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

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?

Type: string[] (optional)

An array of up to three Git repositories associated with the notebook instance.

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?

Type: string (optional)

The Git repository associated with the notebook instance as its default code repository.

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?

Type: string (optional)

Sets whether SageMaker provides internet access to the notebook instance.

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?

Type: IResolvable | InstanceMetadataServiceConfigurationProperty (optional)

Information on the IMDS configuration of the notebook instance.

---

kmsKeyId?

Type: string (optional)

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.

The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide .

---

lifecycleConfigName?

Type: string (optional)

The name of a lifecycle configuration to associate with the notebook instance.

For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .

---

notebookInstanceName?

Type: string (optional)

The name of the new notebook instance.

---

platformIdentifier?

Type: string (optional)

The platform identifier of the notebook instance runtime environment.

---

rootAccess?

Type: string (optional)

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled .

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?

Type: string[] (optional)

The VPC security group IDs, in the form sg-xxxxxxxx.

The security groups must be for the same VPC as specified in the subnet.

---

subnetId?

Type: string (optional)

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

---

volumeSizeInGb?

Type: number (optional)

The size, in GB, of the ML storage volume to attach to the notebook instance.

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.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }