CfnNotebookInstance (software.amazon.awscdk:monocdk 1.75.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - 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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
```
@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:52.793Z")
 @Stability(value=Stable)
public class CfnNotebookInstance
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::SageMaker::NotebookInstance`.

See Also:

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

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 class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- 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 String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnNotebookInstance(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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAcceleratorTypes()` `AWS::SageMaker::NotebookInstance.AcceleratorTypes`.
`List<String>`	`getAdditionalCodeRepositories()` `AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.
`String`	`getAttrNotebookInstanceName()`
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getDefaultCodeRepository()` `AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.
`String`	`getDirectInternetAccess()` `AWS::SageMaker::NotebookInstance.DirectInternetAccess`.
`String`	`getInstanceType()` `AWS::SageMaker::NotebookInstance.InstanceType`.
`String`	`getKmsKeyId()` `AWS::SageMaker::NotebookInstance.KmsKeyId`.
`String`	`getLifecycleConfigName()` `AWS::SageMaker::NotebookInstance.LifecycleConfigName`.
`String`	`getNotebookInstanceName()` `AWS::SageMaker::NotebookInstance.NotebookInstanceName`.
`String`	`getRoleArn()` `AWS::SageMaker::NotebookInstance.RoleArn`.
`String`	`getRootAccess()` `AWS::SageMaker::NotebookInstance.RootAccess`.
`List<String>`	`getSecurityGroupIds()` `AWS::SageMaker::NotebookInstance.SecurityGroupIds`.
`String`	`getSubnetId()` `AWS::SageMaker::NotebookInstance.SubnetId`.
`TagManager`	`getTags()` `AWS::SageMaker::NotebookInstance.Tags`.
`Number`	`getVolumeSizeInGb()` `AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.
`void`	`inspect(TreeInspector inspector)` (experimental) Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAcceleratorTypes(List<String> value)` `AWS::SageMaker::NotebookInstance.AcceleratorTypes`.
`void`	`setAdditionalCodeRepositories(List<String> value)` `AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.
`void`	`setDefaultCodeRepository(String value)` `AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.
`void`	`setDirectInternetAccess(String value)` `AWS::SageMaker::NotebookInstance.DirectInternetAccess`.
`void`	`setInstanceType(String value)` `AWS::SageMaker::NotebookInstance.InstanceType`.
`void`	`setKmsKeyId(String value)` `AWS::SageMaker::NotebookInstance.KmsKeyId`.
`void`	`setLifecycleConfigName(String value)` `AWS::SageMaker::NotebookInstance.LifecycleConfigName`.
`void`	`setNotebookInstanceName(String value)` `AWS::SageMaker::NotebookInstance.NotebookInstanceName`.
`void`	`setRoleArn(String value)` `AWS::SageMaker::NotebookInstance.RoleArn`.
`void`	`setRootAccess(String value)` `AWS::SageMaker::NotebookInstance.RootAccess`.
`void`	`setSecurityGroupIds(List<String> value)` `AWS::SageMaker::NotebookInstance.SecurityGroupIds`.
`void`	`setSubnetId(String value)` `AWS::SageMaker::NotebookInstance.SubnetId`.
`void`	`setVolumeSizeInGb(Number value)` `AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.

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 Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final 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
```
@Stability(value=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 Detail
  - inspect
```
@Stability(value=Experimental)
public void inspect(@NotNull
                                                   TreeInspector inspector)
```
    (experimental) 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
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrNotebookInstanceName
```
@Stability(value=Stable)
 @NotNull
public String getAttrNotebookInstanceName()
```
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    `AWS::SageMaker::NotebookInstance.Tags`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags
  - getInstanceType
```
@Stability(value=Stable)
 @NotNull
public String getInstanceType()
```
    `AWS::SageMaker::NotebookInstance.InstanceType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype
  - setInstanceType
```
@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)
```
    `AWS::SageMaker::NotebookInstance.InstanceType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype
  - getRoleArn
```
@Stability(value=Stable)
 @NotNull
public String getRoleArn()
```
    `AWS::SageMaker::NotebookInstance.RoleArn`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn
  - setRoleArn
```
@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)
```
    `AWS::SageMaker::NotebookInstance.RoleArn`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn
  - getAcceleratorTypes
```
@Stability(value=Stable)
 @Nullable
public List<String> getAcceleratorTypes()
```
    `AWS::SageMaker::NotebookInstance.AcceleratorTypes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes
  - setAcceleratorTypes
```
@Stability(value=Stable)
public void setAcceleratorTypes(@Nullable
                                                         List<String> value)
```
    `AWS::SageMaker::NotebookInstance.AcceleratorTypes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes
  - getAdditionalCodeRepositories
```
@Stability(value=Stable)
 @Nullable
public List<String> getAdditionalCodeRepositories()
```
    `AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories
  - setAdditionalCodeRepositories
```
@Stability(value=Stable)
public void setAdditionalCodeRepositories(@Nullable
                                                                   List<String> value)
```
    `AWS::SageMaker::NotebookInstance.AdditionalCodeRepositories`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories
  - getDefaultCodeRepository
```
@Stability(value=Stable)
 @Nullable
public String getDefaultCodeRepository()
```
    `AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository
  - setDefaultCodeRepository
```
@Stability(value=Stable)
public void setDefaultCodeRepository(@Nullable
                                                              String value)
```
    `AWS::SageMaker::NotebookInstance.DefaultCodeRepository`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository
  - getDirectInternetAccess
```
@Stability(value=Stable)
 @Nullable
public String getDirectInternetAccess()
```
    `AWS::SageMaker::NotebookInstance.DirectInternetAccess`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess
  - setDirectInternetAccess
```
@Stability(value=Stable)
public void setDirectInternetAccess(@Nullable
                                                             String value)
```
    `AWS::SageMaker::NotebookInstance.DirectInternetAccess`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()
```
    `AWS::SageMaker::NotebookInstance.KmsKeyId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid
  - setKmsKeyId
```
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)
```
    `AWS::SageMaker::NotebookInstance.KmsKeyId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid
  - getLifecycleConfigName
```
@Stability(value=Stable)
 @Nullable
public String getLifecycleConfigName()
```
    `AWS::SageMaker::NotebookInstance.LifecycleConfigName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname
  - setLifecycleConfigName
```
@Stability(value=Stable)
public void setLifecycleConfigName(@Nullable
                                                            String value)
```
    `AWS::SageMaker::NotebookInstance.LifecycleConfigName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname
  - getNotebookInstanceName
```
@Stability(value=Stable)
 @Nullable
public String getNotebookInstanceName()
```
    `AWS::SageMaker::NotebookInstance.NotebookInstanceName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename
  - setNotebookInstanceName
```
@Stability(value=Stable)
public void setNotebookInstanceName(@Nullable
                                                             String value)
```
    `AWS::SageMaker::NotebookInstance.NotebookInstanceName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename
  - getRootAccess
```
@Stability(value=Stable)
 @Nullable
public String getRootAccess()
```
    `AWS::SageMaker::NotebookInstance.RootAccess`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess
  - setRootAccess
```
@Stability(value=Stable)
public void setRootAccess(@Nullable
                                                   String value)
```
    `AWS::SageMaker::NotebookInstance.RootAccess`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess
  - getSecurityGroupIds
```
@Stability(value=Stable)
 @Nullable
public List<String> getSecurityGroupIds()
```
    `AWS::SageMaker::NotebookInstance.SecurityGroupIds`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids
  - setSecurityGroupIds
```
@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)
```
    `AWS::SageMaker::NotebookInstance.SecurityGroupIds`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids
  - getSubnetId
```
@Stability(value=Stable)
 @Nullable
public String getSubnetId()
```
    `AWS::SageMaker::NotebookInstance.SubnetId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid
  - setSubnetId
```
@Stability(value=Stable)
public void setSubnetId(@Nullable
                                                 String value)
```
    `AWS::SageMaker::NotebookInstance.SubnetId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid
  - getVolumeSizeInGb
```
@Stability(value=Stable)
 @Nullable
public Number getVolumeSizeInGb()
```
    `AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb
  - setVolumeSizeInGb
```
@Stability(value=Stable)
public void setVolumeSizeInGb(@Nullable
                                                       Number value)
```
    `AWS::SageMaker::NotebookInstance.VolumeSizeInGB`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb

Class CfnNotebookInstance

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

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 software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

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

getRootAccess

setRootAccess

getSecurityGroupIds

setSecurityGroupIds

getSubnetId

setSubnetId

getVolumeSizeInGb

setVolumeSizeInGb