CreateNotebookInstanceInput

public struct CreateNotebookInstanceInput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let acceleratorTypes: [NotebookInstanceAcceleratorType]?

  • 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. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    Declaration

    Swift

    public let additionalCodeRepositories: [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 AWS 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 Amazon SageMaker Notebook Instances.

    Declaration

    Swift

    public let defaultCodeRepository: String?

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

    Declaration

    Swift

    public let directInternetAccess: DirectInternetAccess?

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

    Declaration

    Swift

    public let instanceType: InstanceType

  • The Amazon Resource Name (ARN) of a AWS 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 in the AWS Key Management Service Developer Guide.

    Declaration

    Swift

    public let kmsKeyId: 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.

    Declaration

    Swift

    public let lifecycleConfigName: String?

  • The name of the new notebook instance.

    Declaration

    Swift

    public let notebookInstanceName: String

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

    Declaration

    Swift

    public let roleArn: 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.

    Declaration

    Swift

    public let rootAccess: RootAccess?

  • The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    Declaration

    Swift

    public let securityGroupIds: [String]?

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

    Declaration

    Swift

    public let subnetId: String?

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

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let volumeSizeInGB: Int?

  • Undocumented

    Declaration

    Swift

    public init(acceleratorTypes: [NotebookInstanceAcceleratorType]? = nil, additionalCodeRepositories: [String]? = nil, defaultCodeRepository: String? = nil, directInternetAccess: DirectInternetAccess? = nil, instanceType: InstanceType, kmsKeyId: String? = nil, lifecycleConfigName: String? = nil, notebookInstanceName: String, roleArn: String, rootAccess: RootAccess? = nil, securityGroupIds: [String]? = nil, subnetId: String? = nil, tags: [Tag]? = nil, volumeSizeInGB: Int? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws