AWS::SageMaker::NotebookInstance

SageMaker NotebookInstance

Resource Type definition for AWS::SageMaker::NotebookInstance

Properties

16 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
InstanceType
string
Required
RoleArn
string
Required
AcceleratorTypes
Array<string>
Deprecated
AdditionalCodeRepositories
Array<string>
DefaultCodeRepository
string
DirectInternetAccess
string
Create-only
InstanceMetadataServiceConfiguration
InstanceMetadataServiceConfiguration
KmsKeyId
string
Create-only
LifecycleConfigName
string
NotebookInstanceName
string
Create-only
PlatformIdentifier
string
Create-only
RootAccess
string
SecurityGroupIds
Array<string>
Create-only
SubnetId
string
Create-only
Tags
Array<Tag>
VolumeSizeInGB
integer

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
NotebookInstanceArnstringThe Amazon Resource Name (ARN) of the notebook instance.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SageMaker::NotebookInstance

Resources:
  MyResource:
    Type: AWS::SageMaker::NotebookInstance
    Properties:
      InstanceType: "value"
      RoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermissionec2:DeleteNetworkInterfaceec2:DeleteNetworkInterfacePermissionec2:DescribeNetworkInterfacesec2:DescribeVpcsec2:DescribeDhcpOptionsec2:DescribeSubnetsec2:DescribeSecurityGroupskms:CreateGrantkms:Decryptkms:DescribeKeysagemaker:AddTagssagemaker:CreateNotebookInstancesagemaker:DescribeNotebookInstancesagemaker:ListTagsiam:PassRole

read

sagemaker:DescribeNotebookInstancesagemaker:ListTags

update

ec2:DescribeNetworkInterfacesec2:DescribeVpcsec2:DescribeDhcpOptionsec2:DescribeSubnetsec2:DescribeSecurityGroupssagemaker:AddTagssagemaker:DeleteTagssagemaker:DescribeNotebookInstancesagemaker:StartNotebookInstancesagemaker:StopNotebookInstancesagemaker:UpdateNotebookInstanceiam:PassRole

delete

ec2:DeleteNetworkInterfaceec2:DeleteNetworkInterfacePermissionsagemaker:DeleteNotebookInstancesagemaker:DescribeNotebookInstancesagemaker:StopNotebookInstance

list

sagemaker:ListNotebookInstances

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSageMaker
Properties17
Required2
TaggingSupported
Primary IDNotebookInstanceArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DirectInternetAccessKmsKeyIdNotebookInstanceNamePlatformIdentifierSecurityGroupIdsSubnetId

Related Resources

External Links