software.amazon.awscdk.services.sagemaker

Class CfnNotebookInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnNotebookInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.231Z")
 @Stability(value=Stable)
public class CfnNotebookInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::NotebookInstance`.

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

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(software.constructs.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 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) 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.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                                    software.constructs.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=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

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`.

getInstanceType

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

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

setInstanceType

@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)

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

getRoleArn

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

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getAcceleratorTypes

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

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

setAcceleratorTypes

@Stability(value=Stable)
public void setAcceleratorTypes(@Nullable
                                                         List<String> value)

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

getAdditionalCodeRepositories

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

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

setAdditionalCodeRepositories

@Stability(value=Stable)
public void setAdditionalCodeRepositories(@Nullable
                                                                   List<String> value)

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

getDefaultCodeRepository

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

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

setDefaultCodeRepository

@Stability(value=Stable)
public void setDefaultCodeRepository(@Nullable
                                                              String value)

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

getDirectInternetAccess

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

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

setDirectInternetAccess

@Stability(value=Stable)
public void setDirectInternetAccess(@Nullable
                                                             String value)

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

getKmsKeyId

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

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getLifecycleConfigName

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

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

setLifecycleConfigName

@Stability(value=Stable)
public void setLifecycleConfigName(@Nullable
                                                            String value)

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

getNotebookInstanceName

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

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

setNotebookInstanceName

@Stability(value=Stable)
public void setNotebookInstanceName(@Nullable
                                                             String value)

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

getRootAccess

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

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

setRootAccess

@Stability(value=Stable)
public void setRootAccess(@Nullable
                                                   String value)

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

getSecurityGroupIds

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

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

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

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

getSubnetId

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

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

setSubnetId

@Stability(value=Stable)
public void setSubnetId(@Nullable
                                                 String value)

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

getVolumeSizeInGb

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

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

setVolumeSizeInGb

@Stability(value=Stable)
public void setVolumeSizeInGb(@Nullable
                                                       Number value)

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