package Paws::SageMaker::CreateNotebookInstance; use Moose; has AcceleratorTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has AdditionalCodeRepositories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has DefaultCodeRepository => (is => 'ro', isa => 'Str'); has DirectInternetAccess => (is => 'ro', isa => 'Str'); has InstanceType => (is => 'ro', isa => 'Str', required => 1); has KmsKeyId => (is => 'ro', isa => 'Str'); has LifecycleConfigName => (is => 'ro', isa => 'Str'); has NotebookInstanceName => (is => 'ro', isa => 'Str', required => 1); has RoleArn => (is => 'ro', isa => 'Str', required => 1); has RootAccess => (is => 'ro', isa => 'Str'); has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has SubnetId => (is => 'ro', isa => 'Str'); has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); has VolumeSizeInGB => (is => 'ro', isa => 'Int'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNotebookInstance'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateNotebookInstanceOutput'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::SageMaker::CreateNotebookInstance - Arguments for method CreateNotebookInstance on L =head1 DESCRIPTION This class represents the parameters used for calling the method CreateNotebookInstance on the L service. Use the attributes of this class as arguments to method CreateNotebookInstance. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotebookInstance. =head1 SYNOPSIS my $api.sagemaker = Paws->service('SageMaker'); my $CreateNotebookInstanceOutput = $api . sagemaker->CreateNotebookInstance( InstanceType => 'ml.t2.medium', NotebookInstanceName => 'MyNotebookInstanceName', RoleArn => 'MyRoleArn', AcceleratorTypes => [ 'ml.eia1.medium', ... # values: ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge ], # OPTIONAL AdditionalCodeRepositories => [ 'MyCodeRepositoryNameOrUrl', ... # min: 1, max: 1024 ], # OPTIONAL DefaultCodeRepository => 'MyCodeRepositoryNameOrUrl', # OPTIONAL DirectInternetAccess => 'Enabled', # OPTIONAL KmsKeyId => 'MyKmsKeyId', # OPTIONAL LifecycleConfigName => 'MyNotebookInstanceLifecycleConfigName', # OPTIONAL RootAccess => 'Enabled', # OPTIONAL SecurityGroupIds => [ 'MySecurityGroupId', ... # max: 32 ], # OPTIONAL SubnetId => 'MySubnetId', # OPTIONAL Tags => [ { Key => 'MyTagKey', # min: 1, max: 128 Value => 'MyTagValue', # max: 256 }, ... ], # OPTIONAL VolumeSizeInGB => 1, # OPTIONAL ); # Results: my $NotebookInstanceArn = $CreateNotebookInstanceOutput->NotebookInstanceArn; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 AcceleratorTypes => ArrayRef[Str|Undef] 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html). =head2 AdditionalCodeRepositories => ArrayRef[Str|Undef] 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 (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). =head2 DefaultCodeRepository => Str 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 (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). =head2 DirectInternetAccess => Str Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to C 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). You can set the value of this parameter to C only if you set a value for the C parameter. Valid values are: C<"Enabled">, C<"Disabled"> =head2 B InstanceType => Str The type of ML compute instance to launch for the notebook instance. Valid values are: C<"ml.t2.medium">, C<"ml.t2.large">, C<"ml.t2.xlarge">, C<"ml.t2.2xlarge">, C<"ml.t3.medium">, C<"ml.t3.large">, C<"ml.t3.xlarge">, C<"ml.t3.2xlarge">, C<"ml.m4.xlarge">, C<"ml.m4.2xlarge">, C<"ml.m4.4xlarge">, C<"ml.m4.10xlarge">, C<"ml.m4.16xlarge">, C<"ml.m5.xlarge">, C<"ml.m5.2xlarge">, C<"ml.m5.4xlarge">, C<"ml.m5.12xlarge">, C<"ml.m5.24xlarge">, C<"ml.c4.xlarge">, C<"ml.c4.2xlarge">, C<"ml.c4.4xlarge">, C<"ml.c4.8xlarge">, C<"ml.c5.xlarge">, C<"ml.c5.2xlarge">, C<"ml.c5.4xlarge">, C<"ml.c5.9xlarge">, C<"ml.c5.18xlarge">, C<"ml.c5d.xlarge">, C<"ml.c5d.2xlarge">, C<"ml.c5d.4xlarge">, C<"ml.c5d.9xlarge">, C<"ml.c5d.18xlarge">, C<"ml.p2.xlarge">, C<"ml.p2.8xlarge">, C<"ml.p2.16xlarge">, C<"ml.p3.2xlarge">, C<"ml.p3.8xlarge">, C<"ml.p3.16xlarge"> =head2 KmsKeyId => Str 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 (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the I. =head2 LifecycleConfigName => Str 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). =head2 B NotebookInstanceName => Str The name of the new notebook instance. =head2 B RoleArn => Str 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). To be able to pass this role to Amazon SageMaker, the caller of this API must have the C permission. =head2 RootAccess => Str Whether root access is enabled or disabled for users of the notebook instance. The default value is C. 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. Valid values are: C<"Enabled">, C<"Disabled"> =head2 SecurityGroupIds => ArrayRef[Str|Undef] The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. =head2 SubnetId => Str The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. =head2 Tags => ArrayRef[L] 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). =head2 VolumeSizeInGB => Int The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. =head1 SEE ALSO This class forms part of L, documenting arguments for method CreateNotebookInstance in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut