Struct aws_sdk_sagemaker::client::fluent_builders::CreateNotebookInstanceLifecycleConfig

pub struct CreateNotebookInstanceLifecycleConfig<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateNotebookInstanceLifecycleConfig.

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

Implementations

impl<C, M, R> CreateNotebookInstanceLifecycleConfig<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateNotebookInstanceLifecycleConfigOutput, SdkError<CreateNotebookInstanceLifecycleConfigError>> where
    R::Policy: SmithyRetryPolicy<CreateNotebookInstanceLifecycleConfigInputOperationOutputAlias, CreateNotebookInstanceLifecycleConfigOutput, CreateNotebookInstanceLifecycleConfigError, CreateNotebookInstanceLifecycleConfigInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn notebook_instance_lifecycle_config_name(
    self,
    inp: impl Into<String>
) -> Self

The name of the lifecycle configuration.

pub fn set_notebook_instance_lifecycle_config_name(
    self,
    input: Option<String>
) -> Self

The name of the lifecycle configuration.

pub fn on_create(self, inp: impl Into<NotebookInstanceLifecycleHook>) -> Self

Appends an item to OnCreate.

To override the contents of this collection use set_on_create.

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

pub fn set_on_create(
    self,
    input: Option<Vec<NotebookInstanceLifecycleHook>>
) -> Self

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

pub fn on_start(self, inp: impl Into<NotebookInstanceLifecycleHook>) -> Self

Appends an item to OnStart.

To override the contents of this collection use set_on_start.

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.

pub fn set_on_start(
    self,
    input: Option<Vec<NotebookInstanceLifecycleHook>>
) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateNotebookInstanceLifecycleConfig<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.