Class UpdateNotebookInstanceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,
UpdateNotebookInstanceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of the Elastic Inference (EI) instance types to associate with this notebook instance.A list of the Elastic Inference (EI) instance types to associate with this notebook instance.An array of up to three Git repositories to associate with the notebook instance.builder()
final String
The Git repository to associate with the notebook instance as its default code repository.final Boolean
A list of the Elastic Inference (EI) instance types to remove from this notebook instance.final Boolean
A list of names or URLs of the default Git repositories to remove from this notebook instance.final Boolean
The name or URL of the default Git repository to remove from this notebook instance.final Boolean
Set totrue
to remove the notebook instance lifecycle configuration currently associated with the notebook instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AcceleratorTypes property.final boolean
For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property.final int
hashCode()
Information on the IMDS configuration of the notebook instancefinal InstanceType
The Amazon ML compute instance type.final String
The Amazon ML compute instance type.final String
The name of a lifecycle configuration to associate with the notebook instance.final String
The name of the notebook instance to update.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance.final RootAccess
Whether root access is enabled or disabled for users of the notebook instance.final String
Whether root access is enabled or disabled for users of the notebook instance.static Class
<? extends UpdateNotebookInstanceRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
notebookInstanceName
The name of the notebook instance to update.
- Returns:
- The name of the notebook instance to update.
-
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:
-
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:
-
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
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
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
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
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
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
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
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
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
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
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
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:
-
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:
-
instanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance
- Returns:
- Information on the IMDS configuration of the notebook instance
-
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 interfaceToCopyableBuilder<UpdateNotebookInstanceRequest.Builder,
UpdateNotebookInstanceRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-