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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.842Z")
 @Stability(value=Stable)
public interface CfnNotebookInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::SageMaker::NotebookInstance`.

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")
         .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

Modifier and Type	Method and Description
static CfnNotebookInstanceProps.Builder	builder()
default List<String>	getAcceleratorTypes() `AWS::SageMaker::NotebookInstance.AcceleratorTypes`.
default List<String>	getAdditionalCodeRepositories() `AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.
default String	getDefaultCodeRepository() `AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.
default String	getDirectInternetAccess() `AWS::SageMaker::NotebookInstance.DirectInternetAccess`.
String	getInstanceType() `AWS::SageMaker::NotebookInstance.InstanceType`.
default String	getKmsKeyId() `AWS::SageMaker::NotebookInstance.KmsKeyId`.
default String	getLifecycleConfigName() `AWS::SageMaker::NotebookInstance.LifecycleConfigName`.
default String	getNotebookInstanceName() `AWS::SageMaker::NotebookInstance.NotebookInstanceName`.
default String	getPlatformIdentifier() `AWS::SageMaker::NotebookInstance.PlatformIdentifier`.
String	getRoleArn() `AWS::SageMaker::NotebookInstance.RoleArn`.
default String	getRootAccess() `AWS::SageMaker::NotebookInstance.RootAccess`.
default List<String>	getSecurityGroupIds() `AWS::SageMaker::NotebookInstance.SecurityGroupIds`.
default String	getSubnetId() `AWS::SageMaker::NotebookInstance.SubnetId`.
default List<CfnTag>	getTags() `AWS::SageMaker::NotebookInstance.Tags`.
default Number	getVolumeSizeInGb() `AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAcceleratorTypes

@Stability(value=Stable)
 @Nullable
default List<String> getAcceleratorTypes()

`AWS::SageMaker::NotebookInstance.AcceleratorTypes`.

getAdditionalCodeRepositories

@Stability(value=Stable)
 @Nullable
default List<String> getAdditionalCodeRepositories()

`AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.

getDefaultCodeRepository

@Stability(value=Stable)
 @Nullable
default String getDefaultCodeRepository()

`AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.

getDirectInternetAccess

@Stability(value=Stable)
 @Nullable
default String getDirectInternetAccess()

`AWS::SageMaker::NotebookInstance.DirectInternetAccess`.

getInstanceType

@Stability(value=Stable)
 @NotNull
String getInstanceType()

`AWS::SageMaker::NotebookInstance.InstanceType`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::SageMaker::NotebookInstance.KmsKeyId`.

getLifecycleConfigName

@Stability(value=Stable)
 @Nullable
default String getLifecycleConfigName()

`AWS::SageMaker::NotebookInstance.LifecycleConfigName`.

getNotebookInstanceName

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

`AWS::SageMaker::NotebookInstance.NotebookInstanceName`.

getPlatformIdentifier

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

`AWS::SageMaker::NotebookInstance.PlatformIdentifier`.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

`AWS::SageMaker::NotebookInstance.RoleArn`.

getRootAccess

@Stability(value=Stable)
 @Nullable
default String getRootAccess()

`AWS::SageMaker::NotebookInstance.RootAccess`.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()

`AWS::SageMaker::NotebookInstance.SecurityGroupIds`.

getSubnetId

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

`AWS::SageMaker::NotebookInstance.SubnetId`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::SageMaker::NotebookInstance.Tags`.

getVolumeSizeInGb

@Stability(value=Stable)
 @Nullable
default Number getVolumeSizeInGb()

`AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.

builder

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

Returns:

a CfnNotebookInstanceProps.Builder of CfnNotebookInstanceProps