class Aws::SageMaker::Types::CreateNotebookInstanceInput

@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.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
      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
      volume_size_in_gb: 1,
      accelerator_types: ["ml.eia1.medium"], # accepts ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge
      default_code_repository: "CodeRepositoryNameOrUrl",
      additional_code_repositories: ["CodeRepositoryNameOrUrl"],
      root_access: "Enabled", # accepts Enabled, Disabled
      platform_identifier: "PlatformIdentifier",
    }

@!attribute [rw] notebook_instance_name

The name of the new notebook instance.
@return [String]

@!attribute [rw] instance_type

The type of ML compute instance to launch for the notebook instance.
@return [String]

@!attribute [rw] subnet_id

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

@!attribute [rw] security_group_ids

The VPC security group IDs, in the form sg-xxxxxxxx. The security
groups must be for the same VPC as specified in the subnet.
@return [Array<String>]

@!attribute [rw] role_arn

When you send any requests to Amazon Web Services 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][1].

<note markdown="1"> To be able to pass this role to Amazon SageMaker, the caller of this
API must have the `iam:PassRole` permission.

 </note>

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html
@return [String]

@!attribute [rw] kms_key_id

The Amazon Resource Name (ARN) of a Amazon Web Services Key
Management Service key that Amazon 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][1] in the *Amazon Web Services Key Management
Service Developer Guide*.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html
@return [String]

@!attribute [rw] tags

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][1].

[1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] lifecycle_config_name

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][1].

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html
@return [String]

@!attribute [rw] direct_internet_access

Sets whether Amazon 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 Amazon 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][1]. You can set the value of this parameter to
`Disabled` only if you set a value for the `SubnetId` parameter.

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access
@return [String]

@!attribute [rw] volume_size_in_gb

The size, in GB, of the ML storage volume to attach to the notebook
instance. The default value is 5 GB.
@return [Integer]

@!attribute [rw] accelerator_types

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][1].

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html
@return [Array<String>]

@!attribute [rw] default_code_repository

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][1] 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 Amazon SageMaker Notebook
Instances][2].

[1]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html
[2]: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
@return [String]

@!attribute [rw] additional_code_repositories

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][1] 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 Amazon SageMaker Notebook
Instances][2].

[1]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html
[2]: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
@return [Array<String>]

@!attribute [rw] root_access

Whether root access is enabled or disabled for users of the notebook
instance. The default value is `Enabled`.

<note markdown="1"> 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.

 </note>
@return [String]

@!attribute [rw] platform_identifier

The platform identifier of the notebook instance runtime
environment.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateNotebookInstanceInput AWS API Documentation

Constants

SENSITIVE