Package software.amazon.awssdk.services.sagemaker.model

Class UpdateNotebookInstanceRequest

    • Method Detail

      • notebookInstanceName

        public final String notebookInstanceName()

        The name of the notebook instance to update.

        Returns:
        The name of the notebook instance to update.

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

      • ipAddressType

        public final IPAddressType ipAddressType()

        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.

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

        Returns:
        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.
        See Also:
        IPAddressType

      • ipAddressTypeAsString

        public final String ipAddressTypeAsString()

        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.

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

        Returns:
        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.
        See Also:
        IPAddressType

      • platformIdentifier

        public final String platformIdentifier()

        The platform identifier of the notebook instance runtime environment.

        Returns:
        The platform identifier of the notebook instance runtime environment.

      • roleArn

        public final String roleArn()

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

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

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

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

      • 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 AI 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 AI 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 AI 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 AI 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 the isEmpty() 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 AI 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 AI Notebook Instances.

      • acceleratorTypes

        public final List<NotebookInstanceAcceleratorType> acceleratorTypes()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

        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:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

      • 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 the isEmpty() 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()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

        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:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to associate with this notebook instance.

      • disassociateAcceleratorTypes

        public final Boolean disassociateAcceleratorTypes()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to remove from this notebook instance.

        Returns:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of the EI instance types to remove from this notebook instance.

      • 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 return RootAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootAccessAsString().

        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 return RootAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootAccessAsString().

        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

      • 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.
        Overrides:
        toString in class Object