com.amazonaws.services.sagemaker.model

Class UpdateNotebookInstanceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.UpdateNotebookInstanceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateNotebookInstanceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateNotebookInstanceRequest()

Method Summary

Modifier and Type	Method and Description
UpdateNotebookInstanceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAcceleratorTypes() A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
List<String>	getAdditionalCodeRepositories() An array of up to three Git repositories to associate with the notebook instance.
String	getDefaultCodeRepository() The Git repository to associate with the notebook instance as its default code repository.
Boolean	getDisassociateAcceleratorTypes() A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
Boolean	getDisassociateAdditionalCodeRepositories() A list of names or URLs of the default Git repositories to remove from this notebook instance.
Boolean	getDisassociateDefaultCodeRepository() The name or URL of the default Git repository to remove from this notebook instance.
Boolean	getDisassociateLifecycleConfig() Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
String	getInstanceType() The Amazon ML compute instance type.
String	getLifecycleConfigName() The name of a lifecycle configuration to associate with the notebook instance.
String	getNotebookInstanceName() The name of the notebook instance to update.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance.
String	getRootAccess() Whether root access is enabled or disabled for users of the notebook instance.
Integer	getVolumeSizeInGB() The size, in GB, of the ML storage volume to attach to the notebook instance.
int	hashCode()
Boolean	isDisassociateAcceleratorTypes() A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
Boolean	isDisassociateAdditionalCodeRepositories() A list of names or URLs of the default Git repositories to remove from this notebook instance.
Boolean	isDisassociateDefaultCodeRepository() The name or URL of the default Git repository to remove from this notebook instance.
Boolean	isDisassociateLifecycleConfig() Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
void	setAcceleratorTypes(Collection<String> acceleratorTypes) A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
void	setAdditionalCodeRepositories(Collection<String> additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
void	setDefaultCodeRepository(String defaultCodeRepository) The Git repository to associate with the notebook instance as its default code repository.
void	setDisassociateAcceleratorTypes(Boolean disassociateAcceleratorTypes) A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
void	setDisassociateAdditionalCodeRepositories(Boolean disassociateAdditionalCodeRepositories) A list of names or URLs of the default Git repositories to remove from this notebook instance.
void	setDisassociateDefaultCodeRepository(Boolean disassociateDefaultCodeRepository) The name or URL of the default Git repository to remove from this notebook instance.
void	setDisassociateLifecycleConfig(Boolean disassociateLifecycleConfig) Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
void	setInstanceType(String instanceType) The Amazon ML compute instance type.
void	setLifecycleConfigName(String lifecycleConfigName) The name of a lifecycle configuration to associate with the notebook instance.
void	setNotebookInstanceName(String notebookInstanceName) The name of the notebook instance to update.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance.
void	setRootAccess(String rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
void	setVolumeSizeInGB(Integer volumeSizeInGB) The size, in GB, of the ML storage volume to attach to the notebook instance.
String	toString() Returns a string representation of this object.
UpdateNotebookInstanceRequest	withAcceleratorTypes(Collection<String> acceleratorTypes) A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
UpdateNotebookInstanceRequest	withAcceleratorTypes(NotebookInstanceAcceleratorType... acceleratorTypes) A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
UpdateNotebookInstanceRequest	withAcceleratorTypes(String... acceleratorTypes) A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
UpdateNotebookInstanceRequest	withAdditionalCodeRepositories(Collection<String> additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
UpdateNotebookInstanceRequest	withAdditionalCodeRepositories(String... additionalCodeRepositories) An array of up to three Git repositories to associate with the notebook instance.
UpdateNotebookInstanceRequest	withDefaultCodeRepository(String defaultCodeRepository) The Git repository to associate with the notebook instance as its default code repository.
UpdateNotebookInstanceRequest	withDisassociateAcceleratorTypes(Boolean disassociateAcceleratorTypes) A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
UpdateNotebookInstanceRequest	withDisassociateAdditionalCodeRepositories(Boolean disassociateAdditionalCodeRepositories) A list of names or URLs of the default Git repositories to remove from this notebook instance.
UpdateNotebookInstanceRequest	withDisassociateDefaultCodeRepository(Boolean disassociateDefaultCodeRepository) The name or URL of the default Git repository to remove from this notebook instance.
UpdateNotebookInstanceRequest	withDisassociateLifecycleConfig(Boolean disassociateLifecycleConfig) Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance.
UpdateNotebookInstanceRequest	withInstanceType(InstanceType instanceType) The Amazon ML compute instance type.
UpdateNotebookInstanceRequest	withInstanceType(String instanceType) The Amazon ML compute instance type.
UpdateNotebookInstanceRequest	withLifecycleConfigName(String lifecycleConfigName) The name of a lifecycle configuration to associate with the notebook instance.
UpdateNotebookInstanceRequest	withNotebookInstanceName(String notebookInstanceName) The name of the notebook instance to update.
UpdateNotebookInstanceRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance.
UpdateNotebookInstanceRequest	withRootAccess(RootAccess rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
UpdateNotebookInstanceRequest	withRootAccess(String rootAccess) Whether root access is enabled or disabled for users of the notebook instance.
UpdateNotebookInstanceRequest	withVolumeSizeInGB(Integer volumeSizeInGB) The size, in GB, of the ML storage volume to attach to the notebook instance.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateNotebookInstanceRequest

public UpdateNotebookInstanceRequest()

Method Detail

setNotebookInstanceName

public void setNotebookInstanceName(String notebookInstanceName)

The name of the notebook instance to update.

Parameters:

notebookInstanceName - The name of the notebook instance to update.

getNotebookInstanceName

public String getNotebookInstanceName()

The name of the notebook instance to update.

Returns:

The name of the notebook instance to update.

withNotebookInstanceName

public UpdateNotebookInstanceRequest withNotebookInstanceName(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.

setInstanceType

public void setInstanceType(String instanceType)

The Amazon ML compute instance type.

Parameters:

instanceType - The Amazon ML compute instance type.

See Also:

InstanceType

getInstanceType

public String getInstanceType()

The Amazon ML compute instance type.

Returns:

The Amazon ML compute instance type.

See Also:

InstanceType

withInstanceType

public UpdateNotebookInstanceRequest withInstanceType(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

withInstanceType

public UpdateNotebookInstanceRequest withInstanceType(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:

InstanceType

setRoleArn

public void setRoleArn(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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public UpdateNotebookInstanceRequest withRoleArn(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.

Parameters:

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:

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

setLifecycleConfigName

public void setLifecycleConfigName(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.

getLifecycleConfigName

public String getLifecycleConfigName()

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.

withLifecycleConfigName

public UpdateNotebookInstanceRequest withLifecycleConfigName(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.

setDisassociateLifecycleConfig

public void setDisassociateLifecycleConfig(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.

getDisassociateLifecycleConfig

public Boolean getDisassociateLifecycleConfig()

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:

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.

withDisassociateLifecycleConfig

public UpdateNotebookInstanceRequest withDisassociateLifecycleConfig(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.

isDisassociateLifecycleConfig

public Boolean isDisassociateLifecycleConfig()

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:

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.

setVolumeSizeInGB

public void setVolumeSizeInGB(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 Amazon 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 Amazon 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.

getVolumeSizeInGB

public Integer getVolumeSizeInGB()

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 Amazon 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:

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

withVolumeSizeInGB

public UpdateNotebookInstanceRequest withVolumeSizeInGB(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 Amazon 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 Amazon 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.

setDefaultCodeRepository

public void setDefaultCodeRepository(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.

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

getDefaultCodeRepository

public String getDefaultCodeRepository()

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.

withDefaultCodeRepository

public UpdateNotebookInstanceRequest withDefaultCodeRepository(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.

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

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

getAdditionalCodeRepositories

public List<String> getAdditionalCodeRepositories()

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

Returns:

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

setAdditionalCodeRepositories

public void setAdditionalCodeRepositories(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 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.

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

withAdditionalCodeRepositories

public UpdateNotebookInstanceRequest withAdditionalCodeRepositories(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 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.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalCodeRepositories(java.util.Collection) or withAdditionalCodeRepositories(java.util.Collection) if you want to override the existing values.

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

Returns:

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

withAdditionalCodeRepositories

public UpdateNotebookInstanceRequest withAdditionalCodeRepositories(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 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.

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

Returns:

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

getAcceleratorTypes

public List<String> getAcceleratorTypes()

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:

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.

See Also:

NotebookInstanceAcceleratorType

setAcceleratorTypes

public void setAcceleratorTypes(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.

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public UpdateNotebookInstanceRequest withAcceleratorTypes(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.

NOTE: This method appends the values to the existing list (if any). Use setAcceleratorTypes(java.util.Collection) or withAcceleratorTypes(java.util.Collection) if you want to override the existing values.

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.

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public UpdateNotebookInstanceRequest withAcceleratorTypes(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.

See Also:

NotebookInstanceAcceleratorType

withAcceleratorTypes

public UpdateNotebookInstanceRequest withAcceleratorTypes(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.

See Also:

NotebookInstanceAcceleratorType

setDisassociateAcceleratorTypes

public void setDisassociateAcceleratorTypes(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.

getDisassociateAcceleratorTypes

public Boolean getDisassociateAcceleratorTypes()

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:

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.

withDisassociateAcceleratorTypes

public UpdateNotebookInstanceRequest withDisassociateAcceleratorTypes(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.

isDisassociateAcceleratorTypes

public Boolean isDisassociateAcceleratorTypes()

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:

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.

setDisassociateDefaultCodeRepository

public void setDisassociateDefaultCodeRepository(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.

getDisassociateDefaultCodeRepository

public Boolean getDisassociateDefaultCodeRepository()

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:

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.

withDisassociateDefaultCodeRepository

public UpdateNotebookInstanceRequest withDisassociateDefaultCodeRepository(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.

isDisassociateDefaultCodeRepository

public Boolean isDisassociateDefaultCodeRepository()

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:

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.

setDisassociateAdditionalCodeRepositories

public void setDisassociateAdditionalCodeRepositories(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.

getDisassociateAdditionalCodeRepositories

public Boolean getDisassociateAdditionalCodeRepositories()

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:

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.

withDisassociateAdditionalCodeRepositories

public UpdateNotebookInstanceRequest withDisassociateAdditionalCodeRepositories(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.

isDisassociateAdditionalCodeRepositories

public Boolean isDisassociateAdditionalCodeRepositories()

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:

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.

setRootAccess

public void setRootAccess(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.

See Also:

RootAccess

getRootAccess

public String getRootAccess()

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:

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.

See Also:

RootAccess

withRootAccess

public UpdateNotebookInstanceRequest withRootAccess(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

withRootAccess

public UpdateNotebookInstanceRequest withRootAccess(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:

RootAccess

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateNotebookInstanceRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()