Class: Aws::SageMaker::Types::UpdateNotebookInstanceInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::UpdateNotebookInstanceInput
- Defined in:
- gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#accelerator_types ⇒ Array<String>
A list of the Elastic Inference (EI) instance types to associate with this notebook instance.
-
#additional_code_repositories ⇒ Array<String>
An array of up to three Git repositories to associate with the notebook instance.
-
#default_code_repository ⇒ String
The Git repository to associate with the notebook instance as its default code repository.
-
#disassociate_accelerator_types ⇒ Boolean
A list of the Elastic Inference (EI) instance types to remove from this notebook instance.
-
#disassociate_additional_code_repositories ⇒ Boolean
A list of names or URLs of the default Git repositories to remove from this notebook instance.
-
#disassociate_default_code_repository ⇒ Boolean
The name or URL of the default Git repository to remove from this notebook instance.
-
#disassociate_lifecycle_config ⇒ Boolean
Set to
true
to remove the notebook instance lifecycle configuration currently associated with the notebook instance. -
#instance_metadata_service_configuration ⇒ Types::InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance.
-
#instance_type ⇒ String
The Amazon ML compute instance type.
-
#lifecycle_config_name ⇒ String
The name of a lifecycle configuration to associate with the notebook instance.
-
#notebook_instance_name ⇒ String
The name of the notebook instance to update.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance.
-
#root_access ⇒ String
Whether root access is enabled or disabled for users of the notebook instance.
-
#volume_size_in_gb ⇒ Integer
The size, in GB, of the ML storage volume to attach to the notebook instance.
Instance Attribute Details
#accelerator_types ⇒ Array<String>
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#additional_code_repositories ⇒ Array<String>
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#default_code_repository ⇒ String
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#disassociate_accelerator_types ⇒ Boolean
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#disassociate_additional_code_repositories ⇒ Boolean
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#disassociate_default_code_repository ⇒ Boolean
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#disassociate_lifecycle_config ⇒ Boolean
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#instance_metadata_service_configuration ⇒ Types::InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#instance_type ⇒ String
The Amazon ML compute instance type.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#lifecycle_config_name ⇒ String
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#notebook_instance_name ⇒ String
The name of the notebook instance to update.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.
iam:PassRole
permission.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#root_access ⇒ String
Whether root access is enabled or disabled for users of the notebook
instance. The default value is Enabled
.
Disabled
, users don't have root access on the
notebook instance, but lifecycle configuration scripts still run
with root permissions.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#volume_size_in_gb ⇒ Integer
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.
44039 44040 44041 44042 44043 44044 44045 44046 44047 44048 44049 44050 44051 44052 44053 44054 44055 44056 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 44039 class UpdateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :role_arn, :lifecycle_config_name, :disassociate_lifecycle_config, :volume_size_in_gb, :default_code_repository, :additional_code_repositories, :accelerator_types, :disassociate_accelerator_types, :disassociate_default_code_repository, :disassociate_additional_code_repositories, :root_access, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |