Aws::SageMaker::Model::CreateNotebookInstanceRequest Class Reference

#include <CreateNotebookInstanceRequest.h>

Inheritance diagram for Aws::SageMaker::Model::CreateNotebookInstanceRequest:

Public Member Functions
	CreateNotebookInstanceRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetNotebookInstanceName () const
bool	NotebookInstanceNameHasBeenSet () const
void	SetNotebookInstanceName (const Aws::String &value)
void	SetNotebookInstanceName (Aws::String &&value)
void	SetNotebookInstanceName (const char *value)
CreateNotebookInstanceRequest &	WithNotebookInstanceName (const Aws::String &value)
CreateNotebookInstanceRequest &	WithNotebookInstanceName (Aws::String &&value)
CreateNotebookInstanceRequest &	WithNotebookInstanceName (const char *value)
const InstanceType &	GetInstanceType () const
bool	InstanceTypeHasBeenSet () const
void	SetInstanceType (const InstanceType &value)
void	SetInstanceType (InstanceType &&value)
CreateNotebookInstanceRequest &	WithInstanceType (const InstanceType &value)
CreateNotebookInstanceRequest &	WithInstanceType (InstanceType &&value)
const Aws::String &	GetSubnetId () const
bool	SubnetIdHasBeenSet () const
void	SetSubnetId (const Aws::String &value)
void	SetSubnetId (Aws::String &&value)
void	SetSubnetId (const char *value)
CreateNotebookInstanceRequest &	WithSubnetId (const Aws::String &value)
CreateNotebookInstanceRequest &	WithSubnetId (Aws::String &&value)
CreateNotebookInstanceRequest &	WithSubnetId (const char *value)
const Aws::Vector< Aws::String > &	GetSecurityGroupIds () const
bool	SecurityGroupIdsHasBeenSet () const
void	SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
void	SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
CreateNotebookInstanceRequest &	WithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
CreateNotebookInstanceRequest &	WithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
CreateNotebookInstanceRequest &	AddSecurityGroupIds (const Aws::String &value)
CreateNotebookInstanceRequest &	AddSecurityGroupIds (Aws::String &&value)
CreateNotebookInstanceRequest &	AddSecurityGroupIds (const char *value)
const Aws::String &	GetRoleArn () const
bool	RoleArnHasBeenSet () const
void	SetRoleArn (const Aws::String &value)
void	SetRoleArn (Aws::String &&value)
void	SetRoleArn (const char *value)
CreateNotebookInstanceRequest &	WithRoleArn (const Aws::String &value)
CreateNotebookInstanceRequest &	WithRoleArn (Aws::String &&value)
CreateNotebookInstanceRequest &	WithRoleArn (const char *value)
const Aws::String &	GetKmsKeyId () const
bool	KmsKeyIdHasBeenSet () const
void	SetKmsKeyId (const Aws::String &value)
void	SetKmsKeyId (Aws::String &&value)
void	SetKmsKeyId (const char *value)
CreateNotebookInstanceRequest &	WithKmsKeyId (const Aws::String &value)
CreateNotebookInstanceRequest &	WithKmsKeyId (Aws::String &&value)
CreateNotebookInstanceRequest &	WithKmsKeyId (const char *value)
const Aws::Vector< Tag > &	GetTags () const
bool	TagsHasBeenSet () const
void	SetTags (const Aws::Vector< Tag > &value)
void	SetTags (Aws::Vector< Tag > &&value)
CreateNotebookInstanceRequest &	WithTags (const Aws::Vector< Tag > &value)
CreateNotebookInstanceRequest &	WithTags (Aws::Vector< Tag > &&value)
CreateNotebookInstanceRequest &	AddTags (const Tag &value)
CreateNotebookInstanceRequest &	AddTags (Tag &&value)
const Aws::String &	GetLifecycleConfigName () const
bool	LifecycleConfigNameHasBeenSet () const
void	SetLifecycleConfigName (const Aws::String &value)
void	SetLifecycleConfigName (Aws::String &&value)
void	SetLifecycleConfigName (const char *value)
CreateNotebookInstanceRequest &	WithLifecycleConfigName (const Aws::String &value)
CreateNotebookInstanceRequest &	WithLifecycleConfigName (Aws::String &&value)
CreateNotebookInstanceRequest &	WithLifecycleConfigName (const char *value)
const DirectInternetAccess &	GetDirectInternetAccess () const
bool	DirectInternetAccessHasBeenSet () const
void	SetDirectInternetAccess (const DirectInternetAccess &value)
void	SetDirectInternetAccess (DirectInternetAccess &&value)
CreateNotebookInstanceRequest &	WithDirectInternetAccess (const DirectInternetAccess &value)
CreateNotebookInstanceRequest &	WithDirectInternetAccess (DirectInternetAccess &&value)
int	GetVolumeSizeInGB () const
bool	VolumeSizeInGBHasBeenSet () const
void	SetVolumeSizeInGB (int value)
CreateNotebookInstanceRequest &	WithVolumeSizeInGB (int value)
const Aws::Vector< NotebookInstanceAcceleratorType > &	GetAcceleratorTypes () const
bool	AcceleratorTypesHasBeenSet () const
void	SetAcceleratorTypes (const Aws::Vector< NotebookInstanceAcceleratorType > &value)
void	SetAcceleratorTypes (Aws::Vector< NotebookInstanceAcceleratorType > &&value)
CreateNotebookInstanceRequest &	WithAcceleratorTypes (const Aws::Vector< NotebookInstanceAcceleratorType > &value)
CreateNotebookInstanceRequest &	WithAcceleratorTypes (Aws::Vector< NotebookInstanceAcceleratorType > &&value)
CreateNotebookInstanceRequest &	AddAcceleratorTypes (const NotebookInstanceAcceleratorType &value)
CreateNotebookInstanceRequest &	AddAcceleratorTypes (NotebookInstanceAcceleratorType &&value)
const Aws::String &	GetDefaultCodeRepository () const
bool	DefaultCodeRepositoryHasBeenSet () const
void	SetDefaultCodeRepository (const Aws::String &value)
void	SetDefaultCodeRepository (Aws::String &&value)
void	SetDefaultCodeRepository (const char *value)
CreateNotebookInstanceRequest &	WithDefaultCodeRepository (const Aws::String &value)
CreateNotebookInstanceRequest &	WithDefaultCodeRepository (Aws::String &&value)
CreateNotebookInstanceRequest &	WithDefaultCodeRepository (const char *value)
const Aws::Vector< Aws::String > &	GetAdditionalCodeRepositories () const
bool	AdditionalCodeRepositoriesHasBeenSet () const
void	SetAdditionalCodeRepositories (const Aws::Vector< Aws::String > &value)
void	SetAdditionalCodeRepositories (Aws::Vector< Aws::String > &&value)
CreateNotebookInstanceRequest &	WithAdditionalCodeRepositories (const Aws::Vector< Aws::String > &value)
CreateNotebookInstanceRequest &	WithAdditionalCodeRepositories (Aws::Vector< Aws::String > &&value)
CreateNotebookInstanceRequest &	AddAdditionalCodeRepositories (const Aws::String &value)
CreateNotebookInstanceRequest &	AddAdditionalCodeRepositories (Aws::String &&value)
CreateNotebookInstanceRequest &	AddAdditionalCodeRepositories (const char *value)
const RootAccess &	GetRootAccess () const
bool	RootAccessHasBeenSet () const
void	SetRootAccess (const RootAccess &value)
void	SetRootAccess (RootAccess &&value)
CreateNotebookInstanceRequest &	WithRootAccess (const RootAccess &value)
CreateNotebookInstanceRequest &	WithRootAccess (RootAccess &&value)
const Aws::String &	GetPlatformIdentifier () const
bool	PlatformIdentifierHasBeenSet () const
void	SetPlatformIdentifier (const Aws::String &value)
void	SetPlatformIdentifier (Aws::String &&value)
void	SetPlatformIdentifier (const char *value)
CreateNotebookInstanceRequest &	WithPlatformIdentifier (const Aws::String &value)
CreateNotebookInstanceRequest &	WithPlatformIdentifier (Aws::String &&value)
CreateNotebookInstanceRequest &	WithPlatformIdentifier (const char *value)
Public Member Functions inherited from Aws::SageMaker::SageMakerRequest
virtual	~SageMakerRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 27 of file CreateNotebookInstanceRequest.h.

Constructor & Destructor Documentation

CreateNotebookInstanceRequest()

Aws::SageMaker::Model::CreateNotebookInstanceRequest::CreateNotebookInstanceRequest

(

)

Member Function Documentation

AcceleratorTypesHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::AcceleratorTypesHasBeenSet ( ) const

inline

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.

Definition at line 679 of file CreateNotebookInstanceRequest.h.

AddAcceleratorTypes() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddAcceleratorTypes ( const NotebookInstanceAcceleratorType &  value )

inline

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.

Definition at line 724 of file CreateNotebookInstanceRequest.h.

AddAcceleratorTypes() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddAcceleratorTypes ( NotebookInstanceAcceleratorType &&  value )

inline

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.

Definition at line 733 of file CreateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddAdditionalCodeRepositories ( Aws::String &&  value )

inline

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

Definition at line 943 of file CreateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddAdditionalCodeRepositories ( const Aws::String &  value )

inline

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

Definition at line 930 of file CreateNotebookInstanceRequest.h.

AddAdditionalCodeRepositories() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddAdditionalCodeRepositories ( const char *  value )

inline

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

Definition at line 956 of file CreateNotebookInstanceRequest.h.

AdditionalCodeRepositoriesHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::AdditionalCodeRepositoriesHasBeenSet ( ) const

inline

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

Definition at line 865 of file CreateNotebookInstanceRequest.h.

AddSecurityGroupIds() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddSecurityGroupIds ( Aws::String &&  value )

inline

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

Definition at line 210 of file CreateNotebookInstanceRequest.h.

AddSecurityGroupIds() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddSecurityGroupIds ( const Aws::String &  value )

inline

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

Definition at line 204 of file CreateNotebookInstanceRequest.h.

AddSecurityGroupIds() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddSecurityGroupIds ( const char *  value )

inline

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

Definition at line 216 of file CreateNotebookInstanceRequest.h.

AddTags() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddTags ( const Tag &  value )

inline

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.

Definition at line 482 of file CreateNotebookInstanceRequest.h.

AddTags() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::AddTags ( Tag &&  value )

inline

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.

Definition at line 491 of file CreateNotebookInstanceRequest.h.

DefaultCodeRepositoryHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::DefaultCodeRepositoryHasBeenSet ( ) const

inline

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

Definition at line 760 of file CreateNotebookInstanceRequest.h.

DirectInternetAccessHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::DirectInternetAccessHasBeenSet ( ) const

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 583 of file CreateNotebookInstanceRequest.h.

GetAcceleratorTypes()

const Aws::Vector<NotebookInstanceAcceleratorType>& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetAcceleratorTypes ( ) const

inline

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.

Definition at line 670 of file CreateNotebookInstanceRequest.h.

GetAdditionalCodeRepositories()

const Aws::Vector<Aws::String>& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetAdditionalCodeRepositories ( ) const

inline

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

Definition at line 852 of file CreateNotebookInstanceRequest.h.

GetDefaultCodeRepository()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetDefaultCodeRepository ( ) const

inline

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

Definition at line 747 of file CreateNotebookInstanceRequest.h.

GetDirectInternetAccess()

const DirectInternetAccess& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetDirectInternetAccess ( ) const

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 570 of file CreateNotebookInstanceRequest.h.

GetInstanceType()

const InstanceType& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetInstanceType ( ) const

inline

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

Definition at line 87 of file CreateNotebookInstanceRequest.h.

GetKmsKeyId()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetKmsKeyId ( ) const

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 341 of file CreateNotebookInstanceRequest.h.

GetLifecycleConfigName()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetLifecycleConfigName ( ) const

inline

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.

Definition at line 500 of file CreateNotebookInstanceRequest.h.

GetNotebookInstanceName()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetNotebookInstanceName ( ) const

inline

The name of the new notebook instance.

Definition at line 46 of file CreateNotebookInstanceRequest.h.

GetPlatformIdentifier()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetPlatformIdentifier ( ) const

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1023 of file CreateNotebookInstanceRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SageMaker::SageMakerRequest.

GetRoleArn()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetRoleArn ( ) const

inline

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.

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

Definition at line 231 of file CreateNotebookInstanceRequest.h.

GetRootAccess()

const RootAccess& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetRootAccess ( ) const

inline

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.

Definition at line 967 of file CreateNotebookInstanceRequest.h.

GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetSecurityGroupIds ( ) const

inline

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

Definition at line 168 of file CreateNotebookInstanceRequest.h.

GetServiceRequestName()

virtual const char* Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateNotebookInstanceRequest.h.

GetSubnetId()

const Aws::String& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetSubnetId ( ) const

inline

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

Definition at line 119 of file CreateNotebookInstanceRequest.h.

GetTags()

const Aws::Vector<Tag>& Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetTags ( ) const

inline

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.

Definition at line 428 of file CreateNotebookInstanceRequest.h.

GetVolumeSizeInGB()

int Aws::SageMaker::Model::CreateNotebookInstanceRequest::GetVolumeSizeInGB ( ) const

inline

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

Definition at line 642 of file CreateNotebookInstanceRequest.h.

InstanceTypeHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::InstanceTypeHasBeenSet ( ) const

inline

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

Definition at line 92 of file CreateNotebookInstanceRequest.h.

KmsKeyIdHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::KmsKeyIdHasBeenSet ( ) const

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 352 of file CreateNotebookInstanceRequest.h.

LifecycleConfigNameHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::LifecycleConfigNameHasBeenSet ( ) const

inline

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.

Definition at line 508 of file CreateNotebookInstanceRequest.h.

NotebookInstanceNameHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::NotebookInstanceNameHasBeenSet ( ) const

inline

The name of the new notebook instance.

Definition at line 51 of file CreateNotebookInstanceRequest.h.

PlatformIdentifierHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::PlatformIdentifierHasBeenSet ( ) const

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1028 of file CreateNotebookInstanceRequest.h.

RoleArnHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::RoleArnHasBeenSet ( ) const

inline

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.

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

Definition at line 245 of file CreateNotebookInstanceRequest.h.

RootAccessHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::RootAccessHasBeenSet ( ) const

inline

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.

Definition at line 977 of file CreateNotebookInstanceRequest.h.

SecurityGroupIdsHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::SecurityGroupIdsHasBeenSet ( ) const

inline

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

Definition at line 174 of file CreateNotebookInstanceRequest.h.

SerializePayload()

Aws::String Aws::SageMaker::Model::CreateNotebookInstanceRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetAcceleratorTypes() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetAcceleratorTypes ( Aws::Vector< NotebookInstanceAcceleratorType > &&  value )

inline

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.

Definition at line 697 of file CreateNotebookInstanceRequest.h.

SetAcceleratorTypes() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetAcceleratorTypes ( const Aws::Vector< NotebookInstanceAcceleratorType > &  value )

inline

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.

Definition at line 688 of file CreateNotebookInstanceRequest.h.

SetAdditionalCodeRepositories() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetAdditionalCodeRepositories ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 891 of file CreateNotebookInstanceRequest.h.

SetAdditionalCodeRepositories() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetAdditionalCodeRepositories ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 878 of file CreateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetDefaultCodeRepository ( Aws::String &&  value )

inline

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

Definition at line 786 of file CreateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetDefaultCodeRepository ( const Aws::String &  value )

inline

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

Definition at line 773 of file CreateNotebookInstanceRequest.h.

SetDefaultCodeRepository() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetDefaultCodeRepository ( const char *  value )

inline

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

Definition at line 799 of file CreateNotebookInstanceRequest.h.

SetDirectInternetAccess() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetDirectInternetAccess ( const DirectInternetAccess &  value )

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 596 of file CreateNotebookInstanceRequest.h.

SetDirectInternetAccess() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetDirectInternetAccess ( DirectInternetAccess &&  value )

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 609 of file CreateNotebookInstanceRequest.h.

SetInstanceType() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetInstanceType ( const InstanceType &  value )

inline

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

Definition at line 97 of file CreateNotebookInstanceRequest.h.

SetInstanceType() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetInstanceType ( InstanceType &&  value )

inline

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

Definition at line 102 of file CreateNotebookInstanceRequest.h.

SetKmsKeyId() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetKmsKeyId ( Aws::String &&  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 374 of file CreateNotebookInstanceRequest.h.

SetKmsKeyId() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetKmsKeyId ( const Aws::String &  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 363 of file CreateNotebookInstanceRequest.h.

SetKmsKeyId() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetKmsKeyId ( const char *  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 385 of file CreateNotebookInstanceRequest.h.

SetLifecycleConfigName() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetLifecycleConfigName ( Aws::String &&  value )

inline

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.

Definition at line 524 of file CreateNotebookInstanceRequest.h.

SetLifecycleConfigName() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetLifecycleConfigName ( const Aws::String &  value )

inline

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.

Definition at line 516 of file CreateNotebookInstanceRequest.h.

SetLifecycleConfigName() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetLifecycleConfigName ( const char *  value )

inline

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.

Definition at line 532 of file CreateNotebookInstanceRequest.h.

SetNotebookInstanceName() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetNotebookInstanceName ( Aws::String &&  value )

inline

The name of the new notebook instance.

Definition at line 61 of file CreateNotebookInstanceRequest.h.

SetNotebookInstanceName() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetNotebookInstanceName ( const Aws::String &  value )

inline

The name of the new notebook instance.

Definition at line 56 of file CreateNotebookInstanceRequest.h.

SetNotebookInstanceName() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetNotebookInstanceName ( const char *  value )

inline

The name of the new notebook instance.

Definition at line 66 of file CreateNotebookInstanceRequest.h.

SetPlatformIdentifier() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetPlatformIdentifier ( Aws::String &&  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1038 of file CreateNotebookInstanceRequest.h.

SetPlatformIdentifier() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetPlatformIdentifier ( const Aws::String &  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1033 of file CreateNotebookInstanceRequest.h.

SetPlatformIdentifier() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetPlatformIdentifier ( const char *  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1043 of file CreateNotebookInstanceRequest.h.

SetRoleArn() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetRoleArn ( Aws::String &&  value )

inline

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.

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

Definition at line 273 of file CreateNotebookInstanceRequest.h.

SetRoleArn() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetRoleArn ( const Aws::String &  value )

inline

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.

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

Definition at line 259 of file CreateNotebookInstanceRequest.h.

SetRoleArn() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetRoleArn ( const char *  value )

inline

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.

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

Definition at line 287 of file CreateNotebookInstanceRequest.h.

SetRootAccess() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetRootAccess ( const RootAccess &  value )

inline

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.

Definition at line 987 of file CreateNotebookInstanceRequest.h.

SetRootAccess() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetRootAccess ( RootAccess &&  value )

inline

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.

Definition at line 997 of file CreateNotebookInstanceRequest.h.

SetSecurityGroupIds() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 186 of file CreateNotebookInstanceRequest.h.

SetSecurityGroupIds() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 180 of file CreateNotebookInstanceRequest.h.

SetSubnetId() [1/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetSubnetId ( Aws::String &&  value )

inline

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

Definition at line 137 of file CreateNotebookInstanceRequest.h.

SetSubnetId() [2/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetSubnetId ( const Aws::String &  value )

inline

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

Definition at line 131 of file CreateNotebookInstanceRequest.h.

SetSubnetId() [3/3]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetSubnetId ( const char *  value )

inline

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

Definition at line 143 of file CreateNotebookInstanceRequest.h.

SetTags() [1/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetTags ( Aws::Vector< Tag > &&  value )

inline

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.

Definition at line 455 of file CreateNotebookInstanceRequest.h.

SetTags() [2/2]

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetTags ( const Aws::Vector< Tag > &  value )

inline

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.

Definition at line 446 of file CreateNotebookInstanceRequest.h.

SetVolumeSizeInGB()

void Aws::SageMaker::Model::CreateNotebookInstanceRequest::SetVolumeSizeInGB ( int  value )

inline

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

Definition at line 654 of file CreateNotebookInstanceRequest.h.

SubnetIdHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::SubnetIdHasBeenSet ( ) const

inline

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

Definition at line 125 of file CreateNotebookInstanceRequest.h.

TagsHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::TagsHasBeenSet ( ) const

inline

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.

Definition at line 437 of file CreateNotebookInstanceRequest.h.

VolumeSizeInGBHasBeenSet()

bool Aws::SageMaker::Model::CreateNotebookInstanceRequest::VolumeSizeInGBHasBeenSet ( ) const

inline

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

Definition at line 648 of file CreateNotebookInstanceRequest.h.

WithAcceleratorTypes() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithAcceleratorTypes ( Aws::Vector< NotebookInstanceAcceleratorType > &&  value )

inline

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.

Definition at line 715 of file CreateNotebookInstanceRequest.h.

WithAcceleratorTypes() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithAcceleratorTypes ( const Aws::Vector< NotebookInstanceAcceleratorType > &  value )

inline

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.

Definition at line 706 of file CreateNotebookInstanceRequest.h.

WithAdditionalCodeRepositories() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithAdditionalCodeRepositories ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 917 of file CreateNotebookInstanceRequest.h.

WithAdditionalCodeRepositories() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithAdditionalCodeRepositories ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 904 of file CreateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithDefaultCodeRepository ( Aws::String &&  value )

inline

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

Definition at line 825 of file CreateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithDefaultCodeRepository ( const Aws::String &  value )

inline

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

Definition at line 812 of file CreateNotebookInstanceRequest.h.

WithDefaultCodeRepository() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithDefaultCodeRepository ( const char *  value )

inline

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

Definition at line 838 of file CreateNotebookInstanceRequest.h.

WithDirectInternetAccess() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithDirectInternetAccess ( const DirectInternetAccess &  value )

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 622 of file CreateNotebookInstanceRequest.h.

WithDirectInternetAccess() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithDirectInternetAccess ( DirectInternetAccess &&  value )

inline

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. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

Definition at line 635 of file CreateNotebookInstanceRequest.h.

WithInstanceType() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithInstanceType ( const InstanceType &  value )

inline

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

Definition at line 107 of file CreateNotebookInstanceRequest.h.

WithInstanceType() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithInstanceType ( InstanceType &&  value )

inline

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

Definition at line 112 of file CreateNotebookInstanceRequest.h.

WithKmsKeyId() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithKmsKeyId ( Aws::String &&  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 407 of file CreateNotebookInstanceRequest.h.

WithKmsKeyId() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithKmsKeyId ( const Aws::String &  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 396 of file CreateNotebookInstanceRequest.h.

WithKmsKeyId() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithKmsKeyId ( const char *  value )

inline

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 in the Amazon Web Services Key Management Service Developer Guide.

Definition at line 418 of file CreateNotebookInstanceRequest.h.

WithLifecycleConfigName() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithLifecycleConfigName ( Aws::String &&  value )

inline

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.

Definition at line 548 of file CreateNotebookInstanceRequest.h.

WithLifecycleConfigName() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithLifecycleConfigName ( const Aws::String &  value )

inline

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.

Definition at line 540 of file CreateNotebookInstanceRequest.h.

WithLifecycleConfigName() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithLifecycleConfigName ( const char *  value )

inline

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.

Definition at line 556 of file CreateNotebookInstanceRequest.h.

WithNotebookInstanceName() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithNotebookInstanceName ( Aws::String &&  value )

inline

The name of the new notebook instance.

Definition at line 76 of file CreateNotebookInstanceRequest.h.

WithNotebookInstanceName() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithNotebookInstanceName ( const Aws::String &  value )

inline

The name of the new notebook instance.

Definition at line 71 of file CreateNotebookInstanceRequest.h.

WithNotebookInstanceName() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithNotebookInstanceName ( const char *  value )

inline

The name of the new notebook instance.

Definition at line 81 of file CreateNotebookInstanceRequest.h.

WithPlatformIdentifier() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithPlatformIdentifier ( Aws::String &&  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1053 of file CreateNotebookInstanceRequest.h.

WithPlatformIdentifier() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithPlatformIdentifier ( const Aws::String &  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1048 of file CreateNotebookInstanceRequest.h.

WithPlatformIdentifier() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithPlatformIdentifier ( const char *  value )

inline

The platform identifier of the notebook instance runtime environment.

Definition at line 1058 of file CreateNotebookInstanceRequest.h.

WithRoleArn() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithRoleArn ( Aws::String &&  value )

inline

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.

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

Definition at line 315 of file CreateNotebookInstanceRequest.h.

WithRoleArn() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithRoleArn ( const Aws::String &  value )

inline

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.

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

Definition at line 301 of file CreateNotebookInstanceRequest.h.

WithRoleArn() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithRoleArn ( const char *  value )

inline

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.

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

Definition at line 329 of file CreateNotebookInstanceRequest.h.

WithRootAccess() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithRootAccess ( const RootAccess &  value )

inline

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.

Definition at line 1007 of file CreateNotebookInstanceRequest.h.

WithRootAccess() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithRootAccess ( RootAccess &&  value )

inline

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.

Definition at line 1017 of file CreateNotebookInstanceRequest.h.

WithSecurityGroupIds() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value )

inline

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

Definition at line 198 of file CreateNotebookInstanceRequest.h.

WithSecurityGroupIds() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value )

inline

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

Definition at line 192 of file CreateNotebookInstanceRequest.h.

WithSubnetId() [1/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithSubnetId ( Aws::String &&  value )

inline

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

Definition at line 155 of file CreateNotebookInstanceRequest.h.

WithSubnetId() [2/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithSubnetId ( const Aws::String &  value )

inline

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

Definition at line 149 of file CreateNotebookInstanceRequest.h.

WithSubnetId() [3/3]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithSubnetId ( const char *  value )

inline

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

Definition at line 161 of file CreateNotebookInstanceRequest.h.

WithTags() [1/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithTags ( Aws::Vector< Tag > &&  value )

inline

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.

Definition at line 473 of file CreateNotebookInstanceRequest.h.

WithTags() [2/2]

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithTags ( const Aws::Vector< Tag > &  value )

inline

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.

Definition at line 464 of file CreateNotebookInstanceRequest.h.

WithVolumeSizeInGB()

CreateNotebookInstanceRequest& Aws::SageMaker::Model::CreateNotebookInstanceRequest::WithVolumeSizeInGB ( int  value )

inline

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

Definition at line 660 of file CreateNotebookInstanceRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/CreateNotebookInstanceRequest.h