Interface JupyterLabAppSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>, SdkBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>, SdkPojo
Enclosing class:
JupyterLabAppSettings
@Mutable @NotThreadSafe public static interface JupyterLabAppSettings.Builder extends SdkPojo, CopyableBuilder<JupyterLabAppSettings.Builder,JupyterLabAppSettings>

  • Method Details

    • defaultResourceSpec

      JupyterLabAppSettings.Builder defaultResourceSpec(ResourceSpec defaultResourceSpec)
      Sets the value of the DefaultResourceSpec property for this object.
      Parameters:
      defaultResourceSpec - The new value for the DefaultResourceSpec property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultResourceSpec

      default JupyterLabAppSettings.Builder defaultResourceSpec(Consumer<ResourceSpec.Builder> defaultResourceSpec)
      Sets the value of the DefaultResourceSpec property for this object. This is a convenience method that creates an instance of the ResourceSpec.Builder avoiding the need to create one manually via ResourceSpec.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultResourceSpec(ResourceSpec).

      Parameters:
      defaultResourceSpec - a consumer that will call methods on ResourceSpec.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customImages

      JupyterLabAppSettings.Builder customImages(Collection<CustomImage> customImages)

      A list of custom SageMaker images that are configured to run as a JupyterLab app.

      Parameters:
      customImages - A list of custom SageMaker images that are configured to run as a JupyterLab app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customImages

      JupyterLabAppSettings.Builder customImages(CustomImage... customImages)

      A list of custom SageMaker images that are configured to run as a JupyterLab app.

      Parameters:
      customImages - A list of custom SageMaker images that are configured to run as a JupyterLab app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customImages

      JupyterLabAppSettings.Builder customImages(Consumer<CustomImage.Builder>... customImages)

      A list of custom SageMaker images that are configured to run as a JupyterLab app.

      This is a convenience method that creates an instance of the CustomImage.Builder avoiding the need to create one manually via CustomImage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customImages(List<CustomImage>).

      Parameters:
      customImages - a consumer that will call methods on CustomImage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lifecycleConfigArns

      JupyterLabAppSettings.Builder lifecycleConfigArns(Collection<String> lifecycleConfigArns)

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      Parameters:
      lifecycleConfigArns - The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleConfigArns

      JupyterLabAppSettings.Builder lifecycleConfigArns(String... lifecycleConfigArns)

      The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

      Parameters:
      lifecycleConfigArns - The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeRepositories

      JupyterLabAppSettings.Builder codeRepositories(Collection<CodeRepository> codeRepositories)

      A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

      Parameters:
      codeRepositories - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeRepositories

      JupyterLabAppSettings.Builder codeRepositories(CodeRepository... codeRepositories)

      A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

      Parameters:
      codeRepositories - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeRepositories

      JupyterLabAppSettings.Builder codeRepositories(Consumer<CodeRepository.Builder>... codeRepositories)

      A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

      This is a convenience method that creates an instance of the CodeRepository.Builder avoiding the need to create one manually via CodeRepository.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codeRepositories(List<CodeRepository>).

      Parameters:
      codeRepositories - a consumer that will call methods on CodeRepository.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appLifecycleManagement

      JupyterLabAppSettings.Builder appLifecycleManagement(AppLifecycleManagement appLifecycleManagement)

      Indicates whether idle shutdown is activated for JupyterLab applications.

      Parameters:
      appLifecycleManagement - Indicates whether idle shutdown is activated for JupyterLab applications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • appLifecycleManagement

      default JupyterLabAppSettings.Builder appLifecycleManagement(Consumer<AppLifecycleManagement.Builder> appLifecycleManagement)

      Indicates whether idle shutdown is activated for JupyterLab applications.

      This is a convenience method that creates an instance of the AppLifecycleManagement.Builder avoiding the need to create one manually via AppLifecycleManagement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to appLifecycleManagement(AppLifecycleManagement).

      Parameters:
      appLifecycleManagement - a consumer that will call methods on AppLifecycleManagement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • emrSettings

      JupyterLabAppSettings.Builder emrSettings(EmrSettings emrSettings)

      The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

      Parameters:
      emrSettings - The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emrSettings

      default JupyterLabAppSettings.Builder emrSettings(Consumer<EmrSettings.Builder> emrSettings)

      The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.

      This is a convenience method that creates an instance of the EmrSettings.Builder avoiding the need to create one manually via EmrSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emrSettings(EmrSettings).

      Parameters:
      emrSettings - a consumer that will call methods on EmrSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • builtInLifecycleConfigArn

      JupyterLabAppSettings.Builder builtInLifecycleConfigArn(String builtInLifecycleConfigArn)

      The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

      Parameters:
      builtInLifecycleConfigArn - The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.