Package software.amazon.awscdk.services.sagemaker

Class CfnNotebookInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnNotebookInstance
All Implemented Interfaces:
IInspectable, ITaggable, INotebookInstanceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:48.212Z") @Stability(Stable) public class CfnNotebookInstance extends CfnResource implements IInspectable, INotebookInstanceRef, ITaggable
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 software.amazon.awscdk.services.sagemaker.*;
 CfnNotebookInstance cfnNotebookInstance = CfnNotebookInstance.Builder.create(this, "MyCfnNotebookInstance")
         .instanceType("instanceType")
         .roleArn("roleArn")
         // the properties below are optional
         .acceleratorTypes(List.of("acceleratorTypes"))
         .additionalCodeRepositories(List.of("additionalCodeRepositories"))
         .defaultCodeRepository("defaultCodeRepository")
         .directInternetAccess("directInternetAccess")
         .instanceMetadataServiceConfiguration(InstanceMetadataServiceConfigurationProperty.builder()
                 .minimumInstanceMetadataServiceVersion("minimumInstanceMetadataServiceVersion")
                 .build())
         .kmsKeyId("kmsKeyId")
         .lifecycleConfigName("lifecycleConfigName")
         .notebookInstanceName("notebookInstanceName")
         .platformIdentifier("platformIdentifier")
         .rootAccess("rootAccess")
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetId("subnetId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .volumeSizeInGb(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNotebookInstance

      protected CfnNotebookInstance(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNotebookInstance

      protected CfnNotebookInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNotebookInstance

      @Stability(Stable) public CfnNotebookInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNotebookInstanceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrNotebookInstanceName

      @Stability(Stable) @NotNull public String getAttrNotebookInstanceName()
      The name of the notebook instance, such as MyNotebookInstance .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNotebookInstanceRef

      @Stability(Stable) @NotNull public NotebookInstanceReference getNotebookInstanceRef()
      A reference to a NotebookInstance resource.
      Specified by:
      getNotebookInstanceRef in interface INotebookInstanceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getInstanceType

      @Stability(Stable) @NotNull public String getInstanceType()
      The type of ML compute instance to launch for the notebook instance.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      The type of ML compute instance to launch for the notebook instance.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf.

    • getAcceleratorTypes

      @Stability(Stable) @Nullable public List<String> getAcceleratorTypes()
      A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

    • setAcceleratorTypes

      @Stability(Stable) public void setAcceleratorTypes(@Nullable List<String> value)
      A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

    • getAdditionalCodeRepositories

      @Stability(Stable) @Nullable public List<String> getAdditionalCodeRepositories()
      An array of up to three Git repositories associated with the notebook instance.

    • setAdditionalCodeRepositories

      @Stability(Stable) public void setAdditionalCodeRepositories(@Nullable List<String> value)
      An array of up to three Git repositories associated with the notebook instance.

    • getDefaultCodeRepository

      @Stability(Stable) @Nullable public String getDefaultCodeRepository()
      The Git repository associated with the notebook instance as its default code repository.

    • setDefaultCodeRepository

      @Stability(Stable) public void setDefaultCodeRepository(@Nullable String value)
      The Git repository associated with the notebook instance as its default code repository.

    • getDirectInternetAccess

      @Stability(Stable) @Nullable public String getDirectInternetAccess()
      Sets whether SageMaker AI provides internet access to the notebook instance.

    • setDirectInternetAccess

      @Stability(Stable) public void setDirectInternetAccess(@Nullable String value)
      Sets whether SageMaker AI provides internet access to the notebook instance.

    • getInstanceMetadataServiceConfiguration

      @Stability(Stable) @Nullable public Object getInstanceMetadataServiceConfiguration()
      Information on the IMDS configuration of the notebook instance.

      Returns union: either IResolvable or CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty

    • setInstanceMetadataServiceConfiguration

      @Stability(Stable) public void setInstanceMetadataServiceConfiguration(@Nullable IResolvable value)
      Information on the IMDS configuration of the notebook instance.

    • setInstanceMetadataServiceConfiguration

      @Stability(Stable) public void setInstanceMetadataServiceConfiguration(@Nullable CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty value)
      Information on the IMDS configuration of the notebook instance.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      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.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      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.

    • getLifecycleConfigName

      @Stability(Stable) @Nullable public String getLifecycleConfigName()
      The name of a lifecycle configuration to associate with the notebook instance.

    • setLifecycleConfigName

      @Stability(Stable) public void setLifecycleConfigName(@Nullable String value)
      The name of a lifecycle configuration to associate with the notebook instance.

    • getNotebookInstanceName

      @Stability(Stable) @Nullable public String getNotebookInstanceName()
      The name of the new notebook instance.

    • setNotebookInstanceName

      @Stability(Stable) public void setNotebookInstanceName(@Nullable String value)
      The name of the new notebook instance.

    • getPlatformIdentifier

      @Stability(Stable) @Nullable public String getPlatformIdentifier()
      The platform identifier of the notebook instance runtime environment.

    • setPlatformIdentifier

      @Stability(Stable) public void setPlatformIdentifier(@Nullable String value)
      The platform identifier of the notebook instance runtime environment.

    • getRootAccess

      @Stability(Stable) @Nullable public String getRootAccess()
      Whether root access is enabled or disabled for users of the notebook instance.

      The default value is Enabled .

    • setRootAccess

      @Stability(Stable) public void setRootAccess(@Nullable String value)
      Whether root access is enabled or disabled for users of the notebook instance.

      The default value is Enabled .

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The VPC security group IDs, in the form sg-xxxxxxxx.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The VPC security group IDs, in the form sg-xxxxxxxx.

    • getSubnetId

      @Stability(Stable) @Nullable public String getSubnetId()
      The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@Nullable String value)
      The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs to apply to this resource.

    • getVolumeSizeInGb

      @Stability(Stable) @Nullable public Number getVolumeSizeInGb()
      The size, in GB, of the ML storage volume to attach to the notebook instance.

    • setVolumeSizeInGb

      @Stability(Stable) public void setVolumeSizeInGb(@Nullable Number value)
      The size, in GB, of the ML storage volume to attach to the notebook instance.