Class CfnNotebookInstance
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnNotebookInstance
.static interface
Information on the IMDS configuration of the notebook instance.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnNotebookInstance
(Construct scope, 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
Modifier and TypeMethodDescriptionA list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.An array of up to three Git repositories associated with the notebook instance.The name of the notebook instance, such as `MyNotebookInstance` .The Git repository associated with the notebook instance as its default code repository.Sets whether SageMaker provides internet access to the notebook instance.Information on the IMDS configuration of the notebook instance.The type of ML compute instance to launch for the notebook instance.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 name of a lifecycle configuration to associate with the notebook instance.The name of the new notebook instance.The platform identifier of the notebook instance runtime environment.When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.Whether root access is enabled or disabled for users of the notebook instance.The VPC security group IDs, in the form sg-xxxxxxxx.The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.getTags()
A list of key-value pairs to apply to this resource.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.renderProperties
(Map<String, Object> props) void
setAcceleratorTypes
(List<String> value) A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.void
setAdditionalCodeRepositories
(List<String> value) An array of up to three Git repositories associated with the notebook instance.void
setDefaultCodeRepository
(String value) The Git repository associated with the notebook instance as its default code repository.void
setDirectInternetAccess
(String value) Sets whether SageMaker provides internet access to the notebook instance.void
Information on the IMDS configuration of the notebook instance.void
setInstanceMetadataServiceConfiguration
(CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty value) Information on the IMDS configuration of the notebook instance.void
setInstanceType
(String value) The type of ML compute instance to launch for the notebook instance.void
setKmsKeyId
(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
(String value) The name of a lifecycle configuration to associate with the notebook instance.void
setNotebookInstanceName
(String value) The name of the new notebook instance.void
setPlatformIdentifier
(String value) The platform identifier of the notebook instance runtime environment.void
setRoleArn
(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
(String value) Whether root access is enabled or disabled for users of the notebook instance.void
setSecurityGroupIds
(List<String> value) The VPC security group IDs, in the form sg-xxxxxxxx.void
setSubnetId
(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
(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 software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 Construct scope, @NotNull String id, @NotNull 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 Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrNotebookInstanceName
The name of the notebook instance, such as `MyNotebookInstance` . -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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
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
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
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
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
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
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
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
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
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
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
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 theSubnetId
parameter. -
setDirectInternetAccess
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 theSubnetId
parameter. -
getInstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance. -
setInstanceMetadataServiceConfiguration
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
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
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
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
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
The name of the new notebook instance. -
setNotebookInstanceName
The name of the new notebook instance. -
getPlatformIdentifier
The platform identifier of the notebook instance runtime environment. -
setPlatformIdentifier
The platform identifier of the notebook instance runtime environment. -
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
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
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
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
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. -
setSubnetId
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. -
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
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.
-