Class: Aws::SageMaker::Types::CreateNotebookInstanceInput

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::CreateNotebookInstanceInput

show all

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>
This parameter is no longer supported.
#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 AI 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 AI 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 AI 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>`

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

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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 AI Notebook Instances.

Returns:

(Array<String>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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 AI Notebook Instances.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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 AI 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 AI 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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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

Returns:

(Types::InstanceMetadataServiceConfiguration)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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 AI 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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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 AI assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker AI can perform these tasks. The policy must allow the SageMaker AI service principal (sagemaker.amazonaws.com) permissions to assume this role. 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:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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.

Returns:

(Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10530

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

Class: Aws::SageMaker::Types::CreateNotebookInstanceInput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_types ⇒ Array<String>

#additional_code_repositories ⇒ Array<String>

#default_code_repository ⇒ String

#direct_internet_access ⇒ String

#instance_metadata_service_configuration ⇒ Types::InstanceMetadataServiceConfiguration

#instance_type ⇒ String

#kms_key_id ⇒ String

#lifecycle_config_name ⇒ String

#notebook_instance_name ⇒ String

#platform_identifier ⇒ String

#role_arn ⇒ String

#root_access ⇒ String

#security_group_ids ⇒ Array<String>

#subnet_id ⇒ String

#tags ⇒ Array<Types::Tag>

#volume_size_in_gb ⇒ Integer

#accelerator_types ⇒ `Array<String>`

#additional_code_repositories ⇒ `Array<String>`

#default_code_repository ⇒ `String`

#direct_internet_access ⇒ `String`

#instance_metadata_service_configuration ⇒ `Types::InstanceMetadataServiceConfiguration`

#instance_type ⇒ `String`

#kms_key_id ⇒ `String`

#lifecycle_config_name ⇒ `String`

#notebook_instance_name ⇒ `String`

#platform_identifier ⇒ `String`

#role_arn ⇒ `String`

#root_access ⇒ `String`

#security_group_ids ⇒ `Array<String>`

#subnet_id ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#volume_size_in_gb ⇒ `Integer`