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("software.amazon.awssdk:codegen") public final class UpdateNotebookInstanceRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateNotebookInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 three 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 totrue
to remove the notebook instance lifecycle configuration currently associated with the notebook instance.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAcceleratorTypes()
For responses, this returns true if the service returned a value for the AcceleratorTypes property.boolean
hasAdditionalCodeRepositories()
For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property.int
hashCode()
InstanceMetadataServiceConfiguration
instanceMetadataServiceConfiguration()
Information on the IMDS configuration of the notebook instanceInstanceType
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 SageMaker can assume to access the notebook instance.RootAccess
rootAccess()
Whether root access is enabled or disabled for users of the notebook instance.String
rootAccessAsString()
Whether root access is enabled or disabled for users of the notebook instance.List<SdkField<?>>
sdkFields()
static Class<? extends UpdateNotebookInstanceRequest.Builder>
serializableBuilderClass()
UpdateNotebookInstanceRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
notebookInstanceName
public final String notebookInstanceName()
The name of the notebook instance to update.
- Returns:
- The name of the notebook instance to update.
-
instanceType
public final 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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The Amazon ML compute instance type.
- See Also:
InstanceType
-
instanceTypeAsString
public final 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 returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The Amazon ML compute instance type.
- See Also:
InstanceType
-
roleArn
public final 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.- Returns:
- 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.
-
lifecycleConfigName
public final 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 final 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.- 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.
-
volumeSizeInGB
public final 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.
- 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 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.
-
defaultCodeRepository
public final 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.
- 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 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.
-
hasAdditionalCodeRepositories
public final boolean hasAdditionalCodeRepositories()
For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
additionalCodeRepositories
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdditionalCodeRepositories()
method.- 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 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.
-
acceleratorTypes
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAcceleratorTypes()
method.- 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.
-
hasAcceleratorTypes
public final boolean hasAcceleratorTypes()
For responses, this returns true if the service returned a value for the AcceleratorTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
acceleratorTypesAsStrings
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAcceleratorTypes()
method.- 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 final 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.
- 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.
-
disassociateDefaultCodeRepository
public final 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.
- 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.
-
disassociateAdditionalCodeRepositories
public final 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.
- 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.
-
rootAccess
public final 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.If the service returns an enum value that is not available in the current SDK version,
rootAccess
will returnRootAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootAccessAsString()
.- 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
-
rootAccessAsString
public final String rootAccessAsString()
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.If the service returns an enum value that is not available in the current SDK version,
rootAccess
will returnRootAccess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrootAccessAsString()
.- 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
-
instanceMetadataServiceConfiguration
public final InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration()
Information on the IMDS configuration of the notebook instance
- Returns:
- Information on the IMDS configuration of the notebook instance
-
toBuilder
public UpdateNotebookInstanceRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,UpdateNotebookInstanceRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static UpdateNotebookInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateNotebookInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-