Package software.amazon.awssdk.services.sagemaker.model

Class NotebookInstanceLifecycleHook

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotebookInstanceLifecycleHook.Builder,NotebookInstanceLifecycleHook>
@Generated("software.amazon.awssdk:codegen") public final class NotebookInstanceLifecycleHook extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotebookInstanceLifecycleHook.Builder,NotebookInstanceLifecycleHook>

Contains the notebook instance lifecycle configuration script.

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.

See Also:

  • Method Details

    • content

      public final String content()

      A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

      Returns:
      A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

    • toBuilder

      public NotebookInstanceLifecycleHook.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NotebookInstanceLifecycleHook.Builder,NotebookInstanceLifecycleHook>
      Returns:
      a builder for type T

    • builder

      public static NotebookInstanceLifecycleHook.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NotebookInstanceLifecycleHook.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.