@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:25.596Z") public class CfnNotebookInstanceLifecycleConfig extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNotebookInstanceLifecycleConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnNotebookInstanceLifecycleConfig(Construct scope, java.lang.String id, CfnNotebookInstanceLifecycleConfigProps props)
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.public CfnNotebookInstanceLifecycleConfig(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrNotebookInstanceLifecycleConfigName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getNotebookInstanceLifecycleConfigName()
public void setNotebookInstanceLifecycleConfigName(java.lang.String value)
public java.lang.Object getOnCreate()
The shell script must be a base64-encoded string.
public void setOnCreate(IResolvable value)
The shell script must be a base64-encoded string.
public void setOnCreate(java.util.List<java.lang.Object> value)
The shell script must be a base64-encoded string.
public java.lang.Object getOnStart()
The shell script must be a base64-encoded string.
public void setOnStart(IResolvable value)
The shell script must be a base64-encoded string.
public void setOnStart(java.util.List<java.lang.Object> value)
The shell script must be a base64-encoded string.