CfnNotebookInstanceProps

All Known Implementing Classes:: CfnNotebookInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.964Z")
public interface CfnNotebookInstanceProps

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();

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnNotebookInstanceProps.Builder`	`builder()`
`default java.util.List<java.lang.String>`	`getAcceleratorTypes()` A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
`default java.util.List<java.lang.String>`	`getAdditionalCodeRepositories()` An array of up to three Git repositories associated with the notebook instance.
`default java.lang.String`	`getDefaultCodeRepository()` The Git repository associated with the notebook instance as its default code repository.
`default java.lang.String`	`getDirectInternetAccess()` Sets whether SageMaker provides internet access to the notebook instance.
`default java.lang.Object`	`getInstanceMetadataServiceConfiguration()` Information on the IMDS configuration of the notebook instance.
`java.lang.String`	`getInstanceType()` The type of ML compute instance to launch for the notebook instance.
`default 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.
`default java.lang.String`	`getLifecycleConfigName()` The name of a lifecycle configuration to associate with the notebook instance.
`default java.lang.String`	`getNotebookInstanceName()` The name of the new notebook instance.
`default 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.
`default java.lang.String`	`getRootAccess()` Whether root access is enabled or disabled for users of the notebook instance.
`default java.util.List<java.lang.String>`	`getSecurityGroupIds()` The VPC security group IDs, in the form sg-xxxxxxxx.
`default 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.
`default java.util.List<CfnTag>`	`getTags()` A list of key-value pairs to apply to this resource.
`default java.lang.Number`	`getVolumeSizeInGb()` The size, in GB, of the ML storage volume to attach to the notebook instance.

- Method Detail
  - getInstanceType
```
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.
  - getRoleArn
```
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.
  - getAcceleratorTypes
```
default 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 .
  - getAdditionalCodeRepositories
```
default 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 .
  - getDefaultCodeRepository
```
default 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 .
  - getDirectInternetAccess
```
default 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.
  - getInstanceMetadataServiceConfiguration
```
default java.lang.Object getInstanceMetadataServiceConfiguration()
```
    Information on the IMDS configuration of the notebook instance.
  - getKmsKeyId
```
default 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 .
  - getLifecycleConfigName
```
default 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 .
  - getNotebookInstanceName
```
default java.lang.String getNotebookInstanceName()
```
    The name of the new notebook instance.
  - getPlatformIdentifier
```
default java.lang.String getPlatformIdentifier()
```
    The platform identifier of the notebook instance runtime environment.
  - getRootAccess
```
default 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.
  - getSecurityGroupIds
```
default 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.
  - getSubnetId
```
default 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.
  - getTags
```
default java.util.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.
  - getVolumeSizeInGb
```
default 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.
  - builder
```
static CfnNotebookInstanceProps.Builder builder()
```
    Returns:
    
    a CfnNotebookInstanceProps.Builder of CfnNotebookInstanceProps

Interface CfnNotebookInstanceProps

Nested Class Summary

Method Summary

Method Detail

getInstanceType

getRoleArn

getAcceleratorTypes

getAdditionalCodeRepositories

getDefaultCodeRepository

getDirectInternetAccess

getInstanceMetadataServiceConfiguration

getKmsKeyId

getLifecycleConfigName

getNotebookInstanceName

getPlatformIdentifier

getRootAccess

getSecurityGroupIds

getSubnetId

getTags

getVolumeSizeInGb

builder