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

Interface UpdateNotebookInstanceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>, SageMakerRequest.Builder, SdkBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateNotebookInstanceRequest
public static interface UpdateNotebookInstanceRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>

  • Method Details

    • notebookInstanceName

      UpdateNotebookInstanceRequest.Builder notebookInstanceName(String notebookInstanceName)

      The name of the notebook instance to update.

      Parameters:
      notebookInstanceName - The name of the notebook instance to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      UpdateNotebookInstanceRequest.Builder instanceType(String instanceType)

      The Amazon ML compute instance type.

      Parameters:
      instanceType - The Amazon ML compute instance type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      UpdateNotebookInstanceRequest.Builder instanceType(InstanceType instanceType)

      The Amazon ML compute instance type.

      Parameters:
      instanceType - The Amazon ML compute instance type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      UpdateNotebookInstanceRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

      To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

      To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycleConfigName

      UpdateNotebookInstanceRequest.Builder lifecycleConfigName(String lifecycleConfigName)

      The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

      Parameters:
      lifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disassociateLifecycleConfig

      UpdateNotebookInstanceRequest.Builder disassociateLifecycleConfig(Boolean disassociateLifecycleConfig)

      Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

      Parameters:
      disassociateLifecycleConfig - Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeSizeInGB

      UpdateNotebookInstanceRequest.Builder volumeSizeInGB(Integer volumeSizeInGB)

      The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

      Parameters:
      volumeSizeInGB - The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultCodeRepository

      UpdateNotebookInstanceRequest.Builder defaultCodeRepository(String defaultCodeRepository)

      The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

      Parameters:
      defaultCodeRepository - The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalCodeRepositories

      UpdateNotebookInstanceRequest.Builder additionalCodeRepositories(Collection<String> additionalCodeRepositories)

      An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

      Parameters:
      additionalCodeRepositories - An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalCodeRepositories

      UpdateNotebookInstanceRequest.Builder additionalCodeRepositories(String... additionalCodeRepositories)

      An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

      Parameters:
      additionalCodeRepositories - An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceleratorTypesWithStrings

      UpdateNotebookInstanceRequest.Builder acceleratorTypesWithStrings(Collection<String> acceleratorTypes)

      A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      Parameters:
      acceleratorTypes - A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceleratorTypesWithStrings

      UpdateNotebookInstanceRequest.Builder acceleratorTypesWithStrings(String... acceleratorTypes)

      A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      Parameters:
      acceleratorTypes - A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceleratorTypes

      UpdateNotebookInstanceRequest.Builder acceleratorTypes(Collection<NotebookInstanceAcceleratorType> acceleratorTypes)

      A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      Parameters:
      acceleratorTypes - A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceleratorTypes

      UpdateNotebookInstanceRequest.Builder acceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes)

      A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

      Parameters:
      acceleratorTypes - A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disassociateAcceleratorTypes

      UpdateNotebookInstanceRequest.Builder disassociateAcceleratorTypes(Boolean disassociateAcceleratorTypes)

      A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

      Parameters:
      disassociateAcceleratorTypes - A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disassociateDefaultCodeRepository

      UpdateNotebookInstanceRequest.Builder disassociateDefaultCodeRepository(Boolean disassociateDefaultCodeRepository)

      The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

      Parameters:
      disassociateDefaultCodeRepository - The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disassociateAdditionalCodeRepositories

      UpdateNotebookInstanceRequest.Builder disassociateAdditionalCodeRepositories(Boolean disassociateAdditionalCodeRepositories)

      A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

      Parameters:
      disassociateAdditionalCodeRepositories - A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootAccess

      UpdateNotebookInstanceRequest.Builder rootAccess(String rootAccess)

      Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

      Parameters:
      rootAccess - Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rootAccess

      UpdateNotebookInstanceRequest.Builder rootAccess(RootAccess rootAccess)

      Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

      Parameters:
      rootAccess - Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

      If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceMetadataServiceConfiguration

      UpdateNotebookInstanceRequest.Builder instanceMetadataServiceConfiguration(InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration)

      Information on the IMDS configuration of the notebook instance

      Parameters:
      instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMetadataServiceConfiguration

      default UpdateNotebookInstanceRequest.Builder instanceMetadataServiceConfiguration(Consumer<InstanceMetadataServiceConfiguration.Builder> instanceMetadataServiceConfiguration)

      Information on the IMDS configuration of the notebook instance

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

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

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

    • overrideConfiguration

      UpdateNotebookInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateNotebookInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.