You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateNotebookInstanceInput data as a hash:

{
  notebook_instance_name: "NotebookInstanceName", # required
  instance_type: "ml.t2.medium", # required, accepts ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge
  subnet_id: "SubnetId",
  security_group_ids: ["SecurityGroupId"],
  role_arn: "RoleArn", # required
  kms_key_id: "KmsKeyId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  lifecycle_config_name: "NotebookInstanceLifecycleConfigName",
  direct_internet_access: "Enabled", # accepts Enabled, Disabled
}

Instance Attribute Summary collapse

Instance Attribute Details

#direct_internet_accessString

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.

For more information, see appendix-notebook-and-internet-access. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end

#kms_key_idString

If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  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 notebook-lifecycle-config.

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end

#notebook_instance_nameString

The name of the new notebook instance.

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end

#role_arnString

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.

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

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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


767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

Returns:



767
768
769
770
771
772
773
774
775
776
777
778
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 767

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)
  include Aws::Structure
end