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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_typesArray<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.

Returns:

  • (Array<String>)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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

Returns:

  • (Array<String>)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_repositoryString

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.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_accessString

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.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_configurationTypes::InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance



6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_typeString

The type of ML compute instance to launch for the notebook instance.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_idString

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.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_nameString

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)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_nameString

The name of the new notebook instance.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_identifierString

The platform identifier of the notebook instance runtime environment.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_arnString

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.

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

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_accessString

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)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_idsArray<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>)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_idString

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

Returns:

  • (String)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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

#tagsArray<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:



6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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_gbInteger

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

Returns:

  • (Integer)


6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 6953

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