CfnNotebookInstance

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.sagemaker.CfnNotebookInstance

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:30.359Z")
public class CfnNotebookInstance
extends CfnResource
implements 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 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")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnNotebookInstance.Builder
A fluent builder for CfnNotebookInstance.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnNotebookInstance.Builder` A fluent builder for `CfnNotebookInstance`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnNotebookInstance(Construct scope, java.lang.String id, CfnNotebookInstanceProps props)` Create a new `AWS::SageMaker::NotebookInstance`.
`protected`	`CfnNotebookInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnNotebookInstance(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`getAcceleratorTypes()` A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
`java.util.List<java.lang.String>`	`getAdditionalCodeRepositories()` An array of up to three Git repositories associated with the notebook instance.
`java.lang.String`	`getAttrNotebookInstanceName()` The name of the notebook instance, such as `MyNotebookInstance` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDefaultCodeRepository()` The Git repository associated with the notebook instance as its default code repository.
`java.lang.String`	`getDirectInternetAccess()` Sets whether SageMaker provides internet access to the notebook instance.
`java.lang.String`	`getInstanceType()` The type of ML compute instance to launch for the notebook instance.
`java.lang.String`	`getKmsKeyId()` 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.
`java.lang.String`	`getLifecycleConfigName()` The name of a lifecycle configuration to associate with the notebook instance.
`java.lang.String`	`getNotebookInstanceName()` The name of the new notebook instance.
`java.lang.String`	`getPlatformIdentifier()` The platform identifier of the notebook instance runtime environment.
`java.lang.String`	`getRoleArn()` When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
`java.lang.String`	`getRootAccess()` Whether root access is enabled or disabled for users of the notebook instance.
`java.util.List<java.lang.String>`	`getSecurityGroupIds()` The VPC security group IDs, in the form sg-xxxxxxxx.
`java.lang.String`	`getSubnetId()` The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
`TagManager`	`getTags()` A list of key-value pairs to apply to this resource.
`java.lang.Number`	`getVolumeSizeInGb()` The size, in GB, of the ML storage volume to attach to the notebook instance.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAcceleratorTypes(java.util.List<java.lang.String> value)` A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
`void`	`setAdditionalCodeRepositories(java.util.List<java.lang.String> value)` An array of up to three Git repositories associated with the notebook instance.
`void`	`setDefaultCodeRepository(java.lang.String value)` The Git repository associated with the notebook instance as its default code repository.
`void`	`setDirectInternetAccess(java.lang.String value)` Sets whether SageMaker provides internet access to the notebook instance.
`void`	`setInstanceType(java.lang.String value)` The type of ML compute instance to launch for the notebook instance.
`void`	`setKmsKeyId(java.lang.String value)` 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.
`void`	`setLifecycleConfigName(java.lang.String value)` The name of a lifecycle configuration to associate with the notebook instance.
`void`	`setNotebookInstanceName(java.lang.String value)` The name of the new notebook instance.
`void`	`setPlatformIdentifier(java.lang.String value)` The platform identifier of the notebook instance runtime environment.
`void`	`setRoleArn(java.lang.String value)` When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
`void`	`setRootAccess(java.lang.String value)` Whether root access is enabled or disabled for users of the notebook instance.
`void`	`setSecurityGroupIds(java.util.List<java.lang.String> value)` The VPC security group IDs, in the form sg-xxxxxxxx.
`void`	`setSubnetId(java.lang.String value)` The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
`void`	`setVolumeSizeInGb(java.lang.Number value)` The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnNotebookInstance
```
protected CfnNotebookInstance(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnNotebookInstance
```
protected CfnNotebookInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnNotebookInstance
```
public CfnNotebookInstance(Construct scope,
                           java.lang.String id,
                           CfnNotebookInstanceProps props)
```
    Create a new `AWS::SageMaker::NotebookInstance`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrNotebookInstanceName
```
public java.lang.String getAttrNotebookInstanceName()
```
    The name of the notebook instance, such as `MyNotebookInstance` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    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.
  - getInstanceType
```
public java.lang.String getInstanceType()
```
    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.
  - setInstanceType
```
public void setInstanceType(java.lang.String value)
```
    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.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    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.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    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.
  - getAcceleratorTypes
```
public java.util.List<java.lang.String> getAcceleratorTypes()
```
    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 .
  - setAcceleratorTypes
```
public void setAcceleratorTypes(java.util.List<java.lang.String> value)
```
    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 .
  - getAdditionalCodeRepositories
```
public java.util.List<java.lang.String> getAdditionalCodeRepositories()
```
    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 .
  - setAdditionalCodeRepositories
```
public void setAdditionalCodeRepositories(java.util.List<java.lang.String> value)
```
    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 .
  - getDefaultCodeRepository
```
public java.lang.String getDefaultCodeRepository()
```
    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 .
  - setDefaultCodeRepository
```
public void setDefaultCodeRepository(java.lang.String value)
```
    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 .
  - getDirectInternetAccess
```
public java.lang.String getDirectInternetAccess()
```
    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.
  - setDirectInternetAccess
```
public void setDirectInternetAccess(java.lang.String value)
```
    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.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    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 .
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String value)
```
    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 .
  - getLifecycleConfigName
```
public java.lang.String getLifecycleConfigName()
```
    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 .
  - setLifecycleConfigName
```
public void setLifecycleConfigName(java.lang.String value)
```
    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 .
  - getNotebookInstanceName
```
public java.lang.String getNotebookInstanceName()
```
    The name of the new notebook instance.
  - setNotebookInstanceName
```
public void setNotebookInstanceName(java.lang.String value)
```
    The name of the new notebook instance.
  - getPlatformIdentifier
```
public java.lang.String getPlatformIdentifier()
```
    The platform identifier of the notebook instance runtime environment.
  - setPlatformIdentifier
```
public void setPlatformIdentifier(java.lang.String value)
```
    The platform identifier of the notebook instance runtime environment.
  - getRootAccess
```
public java.lang.String getRootAccess()
```
    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.
  - setRootAccess
```
public void setRootAccess(java.lang.String value)
```
    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.
  - getSecurityGroupIds
```
public java.util.List<java.lang.String> getSecurityGroupIds()
```
    The VPC security group IDs, in the form sg-xxxxxxxx.
    The security groups must be for the same VPC as specified in the subnet.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    The VPC security group IDs, in the form sg-xxxxxxxx.
    The security groups must be for the same VPC as specified in the subnet.
  - getSubnetId
```
public java.lang.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
```
public void setSubnetId(java.lang.String value)
```
    The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
  - getVolumeSizeInGb
```
public java.lang.Number getVolumeSizeInGb()
```
    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.
  - setVolumeSizeInGb
```
public void setVolumeSizeInGb(java.lang.Number value)
```
    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.

Class CfnNotebookInstance

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnNotebookInstance

CfnNotebookInstance

CfnNotebookInstance

Method Detail

inspect

renderProperties

getAttrNotebookInstanceName

getCfnProperties

getTags

getInstanceType

setInstanceType

getRoleArn

setRoleArn

getAcceleratorTypes

setAcceleratorTypes

getAdditionalCodeRepositories

setAdditionalCodeRepositories

getDefaultCodeRepository

setDefaultCodeRepository

getDirectInternetAccess

setDirectInternetAccess

getKmsKeyId

setKmsKeyId

getLifecycleConfigName

setLifecycleConfigName

getNotebookInstanceName

setNotebookInstanceName

getPlatformIdentifier

setPlatformIdentifier

getRootAccess

setRootAccess

getSecurityGroupIds

setSecurityGroupIds

getSubnetId

setSubnetId

getVolumeSizeInGb

setVolumeSizeInGb