NotebookInstanceArgs class

The set of arguments for NotebookInstance. The set of arguments for NotebookInstance.

Constructors

NotebookInstanceArgs({Input<List<String>?>? additionalCodeRepositories, Input<String?>? defaultCodeRepository, Input<String?>? directInternetAccess, Input<NotebookInstanceInstanceMetadataServiceConfiguration?>? instanceMetadataServiceConfiguration, required Input<String> instanceType, Input<String?>? kmsKeyId, Input<String?>? lifecycleConfigName, Input<String?>? name, Input<String?>? platformIdentifier, Input<String?>? region, required Input<String> roleArn, Input<String?>? rootAccess, Input<List<String>?>? securityGroups, Input<String?>? subnetId, Input<Map<String, String>?>? tags, Input<int?>? volumeSize})
Creates a new NotebookInstanceArgs. additionalCodeRepositories An array of up to three Git repositories to associate with the notebook instance. defaultCodeRepository The Git repository associated 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 AWS CodeCommit or in any other Git repository. directInternetAccess Set to Disabled to disable internet access to notebook. Requires securityGroups and subnetId to be set. Supported values: Enabled (Default) or Disabled. If set to Disabled, the notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker AI training and endpoint services unless your configure a NAT Gateway in your VPC. instanceMetadataServiceConfiguration Information on the IMDS configuration of the notebook instance. Conflicts with instanceMetadataServiceConfiguration. see details below. instanceType The name of ML compute instance type. kmsKeyId KMS key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. lifecycleConfigName The name of a lifecycle configuration to associate with the notebook instance. name The name of the notebook instance (must be unique). platformIdentifier The platform identifier of the notebook instance runtime environment. This value can be either notebook-al1-v1(deprecated), notebook-al2-v1(deprecated), notebook-al2-v2(deprecated), notebook-al2-v3, or notebook-al2023-v1, depending on which version of Amazon Linux you require. Defaults to notebook-al2-v3. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn The ARN of the IAM role to be used by the notebook instance which allows SageMaker AI to call other services on your behalf. rootAccess Whether root access is Enabled or Disabled for users of the notebook instance. The default value is Enabled. securityGroups The associated security groups. subnetId The VPC subnet ID. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. volumeSize The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
const
NotebookInstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

additionalCodeRepositories → Input<List<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 AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance.
final
defaultCodeRepository → Input<String?>?
The Git repository associated 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 AWS CodeCommit or in any other Git repository.
final
directInternetAccess → Input<String?>?
Set to Disabled to disable internet access to notebook. Requires securityGroups and subnetId to be set. Supported values: Enabled (Default) or Disabled. If set to Disabled, the notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker AI training and endpoint services unless your configure a NAT Gateway in your VPC.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceMetadataServiceConfiguration → Input<NotebookInstanceInstanceMetadataServiceConfiguration?>?
Information on the IMDS configuration of the notebook instance. Conflicts with instanceMetadataServiceConfiguration. see details below.
final
instanceType → Input<String>
The name of ML compute instance type.
final
kmsKeyId → Input<String?>?
KMS key that Amazon SageMaker AI uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
final
lifecycleConfigName → Input<String?>?
The name of a lifecycle configuration to associate with the notebook instance.
final
name → Input<String?>?
The name of the notebook instance (must be unique).
final
platformIdentifier → Input<String?>?
The platform identifier of the notebook instance runtime environment. This value can be either notebook-al1-v1(deprecated), notebook-al2-v1(deprecated), notebook-al2-v2(deprecated), notebook-al2-v3, or notebook-al2023-v1, depending on which version of Amazon Linux you require. Defaults to notebook-al2-v3.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String>
The ARN of the IAM role to be used by the notebook instance which allows SageMaker AI to call other services on your behalf.
final
rootAccess → Input<String?>?
Whether root access is Enabled or Disabled for users of the notebook instance. The default value is Enabled.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroups → Input<List<String>?>?
The associated security groups.
final
subnetId → Input<String?>?
The VPC subnet ID.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
volumeSize → Input<int?>?
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited