Package software.amazon.awscdk.services.sagemaker

Interface CfnNotebookInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNotebookInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.271Z")
@Stability(Stable)
public interface CfnNotebookInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnNotebookInstance.

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.*;
 CfnNotebookInstanceProps cfnNotebookInstanceProps = CfnNotebookInstanceProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnNotebookInstanceProps.Builder	A builder for CfnNotebookInstanceProps
static final class	CfnNotebookInstanceProps.Jsii$Proxy	An implementation for CfnNotebookInstanceProps

Method Summary

Modifier and Type	Method	Description
static CfnNotebookInstanceProps.Builder	builder()
default List<String>	getAcceleratorTypes()	A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
default List<String>	getAdditionalCodeRepositories()	An array of up to three Git repositories associated with the notebook instance.
default String	getDefaultCodeRepository()	The Git repository associated with the notebook instance as its default code repository.
default String	getDirectInternetAccess()	Sets whether SageMaker provides internet access to the notebook instance.
default Object	getInstanceMetadataServiceConfiguration()	Information on the IMDS configuration of the notebook instance.
String	getInstanceType()	The type of ML compute instance to launch for the notebook instance.
default 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.
default String	getLifecycleConfigName()	The name of a lifecycle configuration to associate with the notebook instance.
default String	getNotebookInstanceName()	The name of the new notebook instance.
default String	getPlatformIdentifier()	The platform identifier of the notebook instance runtime environment.
String	getRoleArn()	When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
default String	getRootAccess()	Whether root access is enabled or disabled for users of the notebook instance.
default List<String>	getSecurityGroupIds()	The VPC security group IDs, in the form sg-xxxxxxxx.
default String	getSubnetId()	The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.
default Number	getVolumeSizeInGb()	The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype

getRoleArn

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn

getAcceleratorTypes

@Stability(Stable)
@Nullable
default List<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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes

getAdditionalCodeRepositories

@Stability(Stable)
@Nullable
default List<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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories

getDefaultCodeRepository

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository

getDirectInternetAccess

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess

getInstanceMetadataServiceConfiguration

@Stability(Stable)
@Nullable
default Object getInstanceMetadataServiceConfiguration()

Information on the IMDS configuration of the notebook instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration

getKmsKeyId

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid

getLifecycleConfigName

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname

getNotebookInstanceName

@Stability(Stable)
@Nullable
default String getNotebookInstanceName()

The name of the new notebook instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename

getPlatformIdentifier

@Stability(Stable)
@Nullable
default String getPlatformIdentifier()

The platform identifier of the notebook instance runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-platformidentifier

getRootAccess

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags

getVolumeSizeInGb

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb

builder

@Stability(Stable)
static CfnNotebookInstanceProps.Builder builder()

Returns:

a CfnNotebookInstanceProps.Builder of CfnNotebookInstanceProps