Syntax Properties Return values Examples

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::SageMaker::NotebookInstance",
  "Properties" : {
      "AcceleratorTypes" : [ String, ... ],
      "AdditionalCodeRepositories" : [ String, ... ],
      "DefaultCodeRepository" : String,
      "DirectInternetAccess" : String,
      "InstanceMetadataServiceConfiguration" : InstanceMetadataServiceConfiguration,
      "InstanceType" : String,
      "KmsKeyId" : String,
      "LifecycleConfigName" : String,
      "NotebookInstanceName" : String,
      "PlatformIdentifier" : String,
      "RoleArn" : String,
      "RootAccess" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SubnetId" : String,
      "Tags" : [ Tag, ... ],
      "VolumeSizeInGB" : Integer
    }
}

YAML


Type: AWS::SageMaker::NotebookInstance
Properties:
  AcceleratorTypes: 
    - String
  AdditionalCodeRepositories: 
    - String
  DefaultCodeRepository: String
  DirectInternetAccess: String
  InstanceMetadataServiceConfiguration: 
    InstanceMetadataServiceConfiguration
  InstanceType: String
  KmsKeyId: String
  LifecycleConfigName: String
  NotebookInstanceName: String
  PlatformIdentifier: String
  RoleArn: String
  RootAccess: String
  SecurityGroupIds: 
    - String
  SubnetId: String
  Tags: 
    - Tag
  VolumeSizeInGB: Integer

Properties

AcceleratorTypes

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.

Required: No

Type: Array of String

Update requires: No interruption

AdditionalCodeRepositories

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 AI Notebook Instances.

Required: No

Type: Array of String

Minimum: 0

Maximum: 3

Update requires: No interruption

DefaultCodeRepository

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 AI Notebook Instances.

Required: No

Type: String

Pattern: https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Minimum: 1

Maximum: 1024

Update requires: No interruption

DirectInternetAccess

Sets whether SageMaker AI 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 AI 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.

Required: No

Type: String

Allowed values: Enabled | Disabled

Update requires: Replacement

InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance

Required: No

Type: InstanceMetadataServiceConfiguration

Update requires: No interruption

InstanceType

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

Note

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

Required: Yes

Type: String

Update requires: No interruption

KmsKeyId

The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker AI 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.

Required: No

Type: String

Pattern: [a-zA-Z0-9:/_-]*

Minimum: 0

Maximum: 2048

Update requires: Replacement

LifecycleConfigName

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.

Required: No

Type: String

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9])*

Minimum: 0

Maximum: 63

Update requires: No interruption

NotebookInstanceName

The name of the new notebook instance.

Required: No

Type: String

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9])*

Minimum: 0

Maximum: 63

Update requires: Replacement

PlatformIdentifier

The platform identifier of the notebook instance runtime environment. The default value is notebook-al2-v2.

Required: No

Type: String

Pattern: (notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3|notebook-al2023-v1)

Minimum: 0

Maximum: 20

Update requires: Replacement

RoleArn

When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker AI Roles.

Note

To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.

Required: Yes

Type: String

Pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Minimum: 20

Maximum: 2048

Update requires: No interruption

RootAccess

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

Note

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.

Required: No

Type: String

Allowed values: Enabled | Disabled

Update requires: No interruption

SecurityGroupIds

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

Required: No

Type: Array of String

Minimum: 0

Maximum: 5

Update requires: Replacement

SubnetId

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

Required: No

Type: String

Pattern: [-0-9a-zA-Z]+

Minimum: 0

Maximum: 32

Update requires: Replacement

Tags

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.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

VolumeSizeInGB

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Note

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

Required: No

Type: Integer

Minimum: 5

Maximum: 16384

Update requires: Some interruptions

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the notebook instance, such as arn:aws:sagemaker:us-west-2:012345678901:notebook-instance/mynotebookinstance.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

NotebookInstanceName: The name of the notebook instance, such as MyNotebookInstance.

Examples

SageMaker Notebook Instance Example

The following example creates a notebook instance.

JSON


{
    "Description": "Create Basic Notebook",
    "Resources": {
        "BasicNotebookInstance": {
            "Type": "AWS::SageMaker::NotebookInstance",
            "Properties": {
                "InstanceType": "ml.t2.large",
                "RoleArn": {
                    "Fn::GetAtt": [
                        "ExecutionRole",
                        "Arn"
                    ]
                }
            }
        },
        "ExecutionRole": {
            "Type": "AWS::IAM::Role",
            "Properties": {
                "AssumeRolePolicyDocument": {
                    "Version": "2012-10-17"		 	 	 ,
                    "Statement": [
                        {
                            "Effect": "Allow",
                            "Principal": {
                                "Service": [
                                    "sagemaker.amazonaws.com"
                                ]
                            },
                            "Action": [
                                "sts:AssumeRole"
                            ]
                        }
                    ]
                },
                "Path": "/",
                "ManagedPolicyArns": [
                    {
                        "Fn::Sub": "arn:${AWS::Partition}:iam::aws:policy/AmazonSageMakerFullAccess"
                    }
                ]
            }
        }
    },
    "Outputs": {
        "BasicNotebookInstanceId": {
            "Value": {
                "Ref": "BasicNotebookInstance"
            }
        }
    }
}

YAML



Description: "Create basic notebook instance"
Resources:
  BasicNotebookInstance:
    Type: "AWS::SageMaker::NotebookInstance"
    Properties:
      InstanceType: "ml.t2.large"
      RoleArn: !GetAtt ExecutionRole.Arn
  ExecutionRole: 
    Type: "AWS::IAM::Role"
    Properties: 
      AssumeRolePolicyDocument: 
        Version: "2012-10-17"
        Statement: 
          - 
            Effect: "Allow"
            Principal: 
              Service: 
                - "sagemaker.amazonaws.com"
            Action: 
              - "sts:AssumeRole"
      Path: "/"
      ManagedPolicyArns:
        - !Sub "arn:${AWS::Partition}:iam::aws:policy/AmazonSageMakerFullAccess"
Outputs:
  BasicNotebookInstanceId:
    Value: !Ref BasicNotebookInstance

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

VpcConfig

InstanceMetadataServiceConfiguration