Class: Aws::SageMaker::Types::CreateNotebookInstanceInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::CreateNotebookInstanceInput
- 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 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
A Git repository to associate with the notebook instance as its default code repository.
-
#direct_internet_access ⇒ String
Sets whether SageMaker provides internet access to the notebook instance.
-
#instance_metadata_service_configuration ⇒ Types::InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance.
-
#instance_type ⇒ String
The type of ML compute instance to launch for the notebook instance.
-
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance.
-
#lifecycle_config_name ⇒ String
The name of a lifecycle configuration to associate with the notebook instance.
-
#notebook_instance_name ⇒ String
The name of the new notebook instance.
-
#platform_identifier ⇒ String
The platform identifier of the notebook instance runtime environment.
-
#role_arn ⇒ String
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf.
-
#root_access ⇒ String
Whether root access is enabled or disabled for users of the notebook instance.
-
#security_group_ids ⇒ Array<String>
The VPC security group IDs, in the form sg-xxxxxxxx.
-
#subnet_id ⇒ String
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
-
#tags ⇒ Array<Types::Tag>
An array of key-value pairs.
-
#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 Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :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.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#default_code_repository ⇒ String
A 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.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#direct_internet_access ⇒ String
Sets whether SageMaker provides internet access to the notebook
instance. If you set this to Disabled
this notebook instance is
able to access resources only in your VPC, and is not be able to
connect to SageMaker training and endpoint services unless you
configure a NAT Gateway in your VPC.
For more information, see Notebook Instances Are Internet-Enabled
by Default. You can set the value of this parameter to
Disabled
only if you set a value for the SubnetId
parameter.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#instance_metadata_service_configuration ⇒ Types::InstanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#instance_type ⇒ String
The type of ML compute instance to launch for the notebook instance.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :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.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#notebook_instance_name ⇒ String
The name of the new notebook instance.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#platform_identifier ⇒ String
The platform identifier of the notebook instance runtime environment.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.
iam:PassRole
permission.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :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
.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#security_group_ids ⇒ Array<String>
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#subnet_id ⇒ String
The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :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.
8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 |
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8230 class CreateNotebookInstanceInput < Struct.new( :notebook_instance_name, :instance_type, :subnet_id, :security_group_ids, :role_arn, :kms_key_id, :tags, :lifecycle_config_name, :direct_internet_access, :volume_size_in_gb, :accelerator_types, :default_code_repository, :additional_code_repositories, :root_access, :platform_identifier, :instance_metadata_service_configuration) SENSITIVE = [] include Aws::Structure end |