Interface DescribeNotebookInstanceResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeNotebookInstanceResponse
public static interface DescribeNotebookInstanceResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeNotebookInstanceResponse.Builder,DescribeNotebookInstanceResponse>

  • Method Details

    • notebookInstanceArn

      DescribeNotebookInstanceResponse.Builder notebookInstanceArn(String notebookInstanceArn)

      The Amazon Resource Name (ARN) of the notebook instance.

      Parameters:
      notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notebookInstanceName

      DescribeNotebookInstanceResponse.Builder notebookInstanceName(String notebookInstanceName)

      The name of the SageMaker notebook instance.

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

    • notebookInstanceStatus

      DescribeNotebookInstanceResponse.Builder notebookInstanceStatus(String notebookInstanceStatus)

      The status of the notebook instance.

      Parameters:
      notebookInstanceStatus - The status of the notebook instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notebookInstanceStatus

      DescribeNotebookInstanceResponse.Builder notebookInstanceStatus(NotebookInstanceStatus notebookInstanceStatus)

      The status of the notebook instance.

      Parameters:
      notebookInstanceStatus - The status of the notebook instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      DescribeNotebookInstanceResponse.Builder failureReason(String failureReason)

      If status is Failed, the reason it failed.

      Parameters:
      failureReason - If status is Failed, the reason it failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • url

      DescribeNotebookInstanceResponse.Builder url(String url)

      The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

      Parameters:
      url - The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      DescribeNotebookInstanceResponse.Builder instanceType(String instanceType)

      The type of ML compute instance running on the notebook instance.

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

    • instanceType

      DescribeNotebookInstanceResponse.Builder instanceType(InstanceType instanceType)

      The type of ML compute instance running on the notebook instance.

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

    • subnetId

      DescribeNotebookInstanceResponse.Builder subnetId(String subnetId)

      The ID of the VPC subnet.

      Parameters:
      subnetId - The ID of the VPC subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      DescribeNotebookInstanceResponse.Builder securityGroups(Collection<String> securityGroups)

      The IDs of the VPC security groups.

      Parameters:
      securityGroups - The IDs of the VPC security groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      DescribeNotebookInstanceResponse.Builder securityGroups(String... securityGroups)

      The IDs of the VPC security groups.

      Parameters:
      securityGroups - The IDs of the VPC security groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      DescribeNotebookInstanceResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role associated with the instance.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      DescribeNotebookInstanceResponse.Builder kmsKeyId(String kmsKeyId)

      The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkInterfaceId

      DescribeNotebookInstanceResponse.Builder networkInterfaceId(String networkInterfaceId)

      The network interface IDs that SageMaker created at the time of creating the instance.

      Parameters:
      networkInterfaceId - The network interface IDs that SageMaker created at the time of creating the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      DescribeNotebookInstanceResponse.Builder lastModifiedTime(Instant lastModifiedTime)

      A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

      Parameters:
      lastModifiedTime - A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      DescribeNotebookInstanceResponse.Builder creationTime(Instant creationTime)

      A timestamp. Use this parameter to return the time when the notebook instance was created

      Parameters:
      creationTime - A timestamp. Use this parameter to return the time when the notebook instance was created
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notebookInstanceLifecycleConfigName

      DescribeNotebookInstanceResponse.Builder notebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)

      Returns the name of a notebook instance lifecycle configuration.

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

      Parameters:
      notebookInstanceLifecycleConfigName - Returns the name of a notebook instance lifecycle configuration.

      For information about notebook instance 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.

    • directInternetAccess

      DescribeNotebookInstanceResponse.Builder directInternetAccess(String directInternetAccess)

      Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

      For more information, see Notebook Instances Are Internet-Enabled by Default.

      Parameters:
      directInternetAccess - Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

      For more information, see Notebook Instances Are Internet-Enabled by Default.

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

    • directInternetAccess

      DescribeNotebookInstanceResponse.Builder directInternetAccess(DirectInternetAccess directInternetAccess)

      Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

      For more information, see Notebook Instances Are Internet-Enabled by Default.

      Parameters:
      directInternetAccess - Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

      For more information, see Notebook Instances Are Internet-Enabled by Default.

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

    • volumeSizeInGB

      DescribeNotebookInstanceResponse.Builder volumeSizeInGB(Integer volumeSizeInGB)

      The size, in GB, of the ML storage volume attached to the notebook instance.

      Parameters:
      volumeSizeInGB - The size, in GB, of the ML storage volume attached to the notebook instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceleratorTypesWithStrings

      DescribeNotebookInstanceResponse.Builder acceleratorTypesWithStrings(Collection<String> acceleratorTypes)

      A list of the Elastic Inference (EI) instance types associated 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 associated 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

      DescribeNotebookInstanceResponse.Builder acceleratorTypesWithStrings(String... acceleratorTypes)

      A list of the Elastic Inference (EI) instance types associated 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 associated 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

      DescribeNotebookInstanceResponse.Builder acceleratorTypes(Collection<NotebookInstanceAcceleratorType> acceleratorTypes)

      A list of the Elastic Inference (EI) instance types associated 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 associated 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

      DescribeNotebookInstanceResponse.Builder acceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes)

      A list of the Elastic Inference (EI) instance types associated 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 associated 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.

    • defaultCodeRepository

      DescribeNotebookInstanceResponse.Builder defaultCodeRepository(String defaultCodeRepository)

      The Git repository associated 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 associated 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

      DescribeNotebookInstanceResponse.Builder additionalCodeRepositories(Collection<String> additionalCodeRepositories)

      An array of up to three Git repositories associated 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 associated 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

      DescribeNotebookInstanceResponse.Builder additionalCodeRepositories(String... additionalCodeRepositories)

      An array of up to three Git repositories associated 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 associated 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.

    • rootAccess

      DescribeNotebookInstanceResponse.Builder rootAccess(String rootAccess)

      Whether root access is enabled or disabled for users of the notebook instance.

      Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

      Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

    • rootAccess

      DescribeNotebookInstanceResponse.Builder rootAccess(RootAccess rootAccess)

      Whether root access is enabled or disabled for users of the notebook instance.

      Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

      Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

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

    • platformIdentifier

      DescribeNotebookInstanceResponse.Builder platformIdentifier(String platformIdentifier)

      The platform identifier of the notebook instance runtime environment.

      Parameters:
      platformIdentifier - The platform identifier of the notebook instance runtime environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMetadataServiceConfiguration

      DescribeNotebookInstanceResponse.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 DescribeNotebookInstanceResponse.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: