software.amazon.awssdk.services.sagemaker.model

Class UpdateNotebookInstanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.UpdateNotebookInstanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateNotebookInstanceRequest
extends SageMakerRequest
implements ToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateNotebookInstanceRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<NotebookInstanceAcceleratorType>	acceleratorTypes() A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	acceleratorTypesAsStrings() A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	additionalCodeRepositories() An array of up to 3 git repositories to associate with the notebook instance.
static UpdateNotebookInstanceRequest.Builder	builder()
String	defaultCodeRepository() The git repository to associate with the notebook instance as its default code repository.
Boolean	disassociateAcceleratorTypes() A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
Boolean	disassociateAdditionalCodeRepositories() A list of names or URLs of the default git repositories to remove from this notebook instance.
Boolean	disassociateDefaultCodeRepository() The name or URL of the default git repository to remove from this notebook instance.
Boolean	disassociateLifecycleConfig() Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
InstanceType	instanceType() The Amazon ML compute instance type.
String	instanceTypeAsString() The Amazon ML compute instance type.
String	lifecycleConfigName() The name of a lifecycle configuration to associate with the notebook instance.
String	notebookInstanceName() The name of the notebook instance to update.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNotebookInstanceRequest.Builder>	serializableBuilderClass()
UpdateNotebookInstanceRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	volumeSizeInGB() The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

notebookInstanceName

public String notebookInstanceName()

The name of the notebook instance to update.

Returns:

The name of the notebook instance to update.

instanceType

public InstanceType instanceType()

The Amazon ML compute instance type.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon ML compute instance type.

See Also:

InstanceType

instanceTypeAsString

public String instanceTypeAsString()

The Amazon ML compute instance type.

If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon ML compute instance type.

See Also:

InstanceType

roleArn

public String roleArn()

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

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

Returns:

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

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

lifecycleConfigName

public 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.

Returns:

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.

disassociateLifecycleConfig

public Boolean disassociateLifecycleConfig()

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.

Returns:

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.

volumeSizeInGB

public Integer volumeSizeInGB()

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Returns:

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

defaultCodeRepository

public 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 AWS 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 Amazon SageMaker Notebook Instances.

Returns:

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 AWS 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 Amazon SageMaker Notebook Instances.

additionalCodeRepositories

public List<String> additionalCodeRepositories()

An array of up to 3 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 AWS 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 Amazon SageMaker Notebook Instances.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of up to 3 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 AWS 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 Amazon SageMaker Notebook Instances.

acceleratorTypes

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

acceleratorTypesAsStrings

public List<String> acceleratorTypesAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

disassociateAcceleratorTypes

public Boolean disassociateAcceleratorTypes()

A list of the Elastic Inference (EI) instance types to remove from this notebook instance.

Returns:

A list of the Elastic Inference (EI) instance types to remove from this notebook instance.

disassociateDefaultCodeRepository

public Boolean disassociateDefaultCodeRepository()

The name or URL of the default git repository to remove from this notebook instance.

Returns:

The name or URL of the default git repository to remove from this notebook instance.

disassociateAdditionalCodeRepositories

public Boolean disassociateAdditionalCodeRepositories()

A list of names or URLs of the default git repositories to remove from this notebook instance.

Returns:

A list of names or URLs of the default git repositories to remove from this notebook instance.

toBuilder

public UpdateNotebookInstanceRequest.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<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static UpdateNotebookInstanceRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.