software.amazon.awscdk.services.sagemaker

Class CfnNotebookInstanceLifecycleConfig

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.596Z")
public class CfnNotebookInstanceLifecycleConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::NotebookInstanceLifecycleConfig`.

The AWS::SageMaker::NotebookInstanceLifecycleConfig resource creates shell scripts that run when you create and/or start a notebook instance. For information about notebook instance lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .

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.*;
 CfnNotebookInstanceLifecycleConfig cfnNotebookInstanceLifecycleConfig = CfnNotebookInstanceLifecycleConfig.Builder.create(this, "MyCfnNotebookInstanceLifecycleConfig")
         .notebookInstanceLifecycleConfigName("notebookInstanceLifecycleConfigName")
         .onCreate(List.of(NotebookInstanceLifecycleHookProperty.builder()
                 .content("content")
                 .build()))
         .onStart(List.of(NotebookInstanceLifecycleHookProperty.builder()
                 .content("content")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNotebookInstanceLifecycleConfig.Builder A fluent builder for CfnNotebookInstanceLifecycleConfig.
static interface	CfnNotebookInstanceLifecycleConfig.NotebookInstanceLifecycleHookProperty Specifies the notebook instance lifecycle configuration script.

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNotebookInstanceLifecycleConfig(Construct scope, java.lang.String id) Create a new `AWS::SageMaker::NotebookInstanceLifecycleConfig`.
	CfnNotebookInstanceLifecycleConfig(Construct scope, java.lang.String id, CfnNotebookInstanceLifecycleConfigProps props) Create a new `AWS::SageMaker::NotebookInstanceLifecycleConfig`.
protected	CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrNotebookInstanceLifecycleConfigName() The name of the lifecycle configuration, such as `MyLifecycleConfig` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getNotebookInstanceLifecycleConfigName() The name of the lifecycle configuration.
java.lang.Object	getOnCreate() A shell script that runs only once, when you create a notebook instance.
java.lang.Object	getOnStart() A shell script that runs every time you start a notebook instance, including when you create the notebook instance.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setNotebookInstanceLifecycleConfigName(java.lang.String value) The name of the lifecycle configuration.
void	setOnCreate(IResolvable value) A shell script that runs only once, when you create a notebook instance.
void	setOnCreate(java.util.List<java.lang.Object> value) A shell script that runs only once, when you create a notebook instance.
void	setOnStart(IResolvable value) A shell script that runs every time you start a notebook instance, including when you create the notebook instance.
void	setOnStart(java.util.List<java.lang.Object> value) A shell script that runs every time you start a notebook instance, including when you create the notebook instance.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNotebookInstanceLifecycleConfig

protected CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnNotebookInstanceLifecycleConfig

protected CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnNotebookInstanceLifecycleConfig

public CfnNotebookInstanceLifecycleConfig(Construct scope,
                                          java.lang.String id,
                                          CfnNotebookInstanceLifecycleConfigProps props)

Create a new `AWS::SageMaker::NotebookInstanceLifecycleConfig`.

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.

CfnNotebookInstanceLifecycleConfig

public CfnNotebookInstanceLifecycleConfig(Construct scope,
                                          java.lang.String id)

Create a new `AWS::SageMaker::NotebookInstanceLifecycleConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNotebookInstanceLifecycleConfigName

public java.lang.String getAttrNotebookInstanceLifecycleConfigName()

The name of the lifecycle configuration, such as `MyLifecycleConfig` .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getNotebookInstanceLifecycleConfigName

public java.lang.String getNotebookInstanceLifecycleConfigName()

The name of the lifecycle configuration.

setNotebookInstanceLifecycleConfigName

public void setNotebookInstanceLifecycleConfigName(java.lang.String value)

The name of the lifecycle configuration.

getOnCreate

public java.lang.Object getOnCreate()

A shell script that runs only once, when you create a notebook instance.

The shell script must be a base64-encoded string.

setOnCreate

public void setOnCreate(IResolvable value)

A shell script that runs only once, when you create a notebook instance.

The shell script must be a base64-encoded string.

setOnCreate

public void setOnCreate(java.util.List<java.lang.Object> value)

A shell script that runs only once, when you create a notebook instance.

The shell script must be a base64-encoded string.

getOnStart

public java.lang.Object getOnStart()

A shell script that runs every time you start a notebook instance, including when you create the notebook instance.

The shell script must be a base64-encoded string.

setOnStart

public void setOnStart(IResolvable value)

A shell script that runs every time you start a notebook instance, including when you create the notebook instance.

The shell script must be a base64-encoded string.

setOnStart

public void setOnStart(java.util.List<java.lang.Object> value)

A shell script that runs every time you start a notebook instance, including when you create the notebook instance.

The shell script must be a base64-encoded string.