Package software.amazon.awscdk.services.sagemaker

Class CfnNotebookInstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnNotebookInstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNotebookInstanceProps>

Enclosing interface:

CfnNotebookInstanceProps

@Stability(Stable)
public static final class CfnNotebookInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNotebookInstanceProps>

A builder for CfnNotebookInstanceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnNotebookInstanceProps.Builder	acceleratorTypes(List<String> acceleratorTypes)	Sets the value of CfnNotebookInstanceProps.getAcceleratorTypes()
CfnNotebookInstanceProps.Builder	additionalCodeRepositories(List<String> additionalCodeRepositories)	Sets the value of CfnNotebookInstanceProps.getAdditionalCodeRepositories()
CfnNotebookInstanceProps	build()	Builds the configured instance.
CfnNotebookInstanceProps.Builder	defaultCodeRepository(String defaultCodeRepository)	Sets the value of CfnNotebookInstanceProps.getDefaultCodeRepository()
CfnNotebookInstanceProps.Builder	directInternetAccess(String directInternetAccess)	Sets the value of CfnNotebookInstanceProps.getDirectInternetAccess()
CfnNotebookInstanceProps.Builder	instanceMetadataServiceConfiguration(IResolvable instanceMetadataServiceConfiguration)	Sets the value of CfnNotebookInstanceProps.getInstanceMetadataServiceConfiguration()
CfnNotebookInstanceProps.Builder	instanceMetadataServiceConfiguration(CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty instanceMetadataServiceConfiguration)	Sets the value of CfnNotebookInstanceProps.getInstanceMetadataServiceConfiguration()
CfnNotebookInstanceProps.Builder	instanceType(String instanceType)	Sets the value of CfnNotebookInstanceProps.getInstanceType()
CfnNotebookInstanceProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnNotebookInstanceProps.getKmsKeyId()
CfnNotebookInstanceProps.Builder	lifecycleConfigName(String lifecycleConfigName)	Sets the value of CfnNotebookInstanceProps.getLifecycleConfigName()
CfnNotebookInstanceProps.Builder	notebookInstanceName(String notebookInstanceName)	Sets the value of CfnNotebookInstanceProps.getNotebookInstanceName()
CfnNotebookInstanceProps.Builder	platformIdentifier(String platformIdentifier)	Sets the value of CfnNotebookInstanceProps.getPlatformIdentifier()
CfnNotebookInstanceProps.Builder	roleArn(String roleArn)	Sets the value of CfnNotebookInstanceProps.getRoleArn()
CfnNotebookInstanceProps.Builder	rootAccess(String rootAccess)	Sets the value of CfnNotebookInstanceProps.getRootAccess()
CfnNotebookInstanceProps.Builder	securityGroupIds(List<String> securityGroupIds)	Sets the value of CfnNotebookInstanceProps.getSecurityGroupIds()
CfnNotebookInstanceProps.Builder	subnetId(String subnetId)	Sets the value of CfnNotebookInstanceProps.getSubnetId()
CfnNotebookInstanceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnNotebookInstanceProps.getTags()
CfnNotebookInstanceProps.Builder	volumeSizeInGb(Number volumeSizeInGb)	Sets the value of CfnNotebookInstanceProps.getVolumeSizeInGb()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

instanceType

@Stability(Stable)
public CfnNotebookInstanceProps.Builder instanceType(String instanceType)

Sets the value of CfnNotebookInstanceProps.getInstanceType()

Parameters:

instanceType - The type of ML compute instance to launch for the notebook instance. This parameter is required.

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

Returns:

this

roleArn

@Stability(Stable)
public CfnNotebookInstanceProps.Builder roleArn(String roleArn)

Sets the value of CfnNotebookInstanceProps.getRoleArn()

Parameters:

roleArn - When you send any requests to AWS resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. This parameter is required. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles .

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

Returns:

this

acceleratorTypes

@Stability(Stable)
public CfnNotebookInstanceProps.Builder acceleratorTypes(List<String> acceleratorTypes)

Sets the value of CfnNotebookInstanceProps.getAcceleratorTypes()

Parameters:

acceleratorTypes - A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker .

Valid Values: ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge | ml.eia2.medium | ml.eia2.large | ml.eia2.xlarge .

Returns:

this

additionalCodeRepositories

@Stability(Stable)
public CfnNotebookInstanceProps.Builder additionalCodeRepositories(List<String> additionalCodeRepositories)

Sets the value of CfnNotebookInstanceProps.getAdditionalCodeRepositories()

Parameters:

additionalCodeRepositories - An array of up to three Git repositories associated 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 SageMaker Notebook Instances .

Returns:

this

defaultCodeRepository

@Stability(Stable)
public CfnNotebookInstanceProps.Builder defaultCodeRepository(String defaultCodeRepository)

Sets the value of CfnNotebookInstanceProps.getDefaultCodeRepository()

Parameters:

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. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances .

Returns:

this

directInternetAccess

@Stability(Stable)
public CfnNotebookInstanceProps.Builder directInternetAccess(String directInternetAccess)

Sets the value of CfnNotebookInstanceProps.getDirectInternetAccess()

Parameters:

directInternetAccess - Sets whether 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 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.

Returns:

this

instanceMetadataServiceConfiguration

@Stability(Stable)
public CfnNotebookInstanceProps.Builder instanceMetadataServiceConfiguration(IResolvable instanceMetadataServiceConfiguration)

Sets the value of CfnNotebookInstanceProps.getInstanceMetadataServiceConfiguration()

Parameters:

instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance.

Returns:

this

instanceMetadataServiceConfiguration

@Stability(Stable)
public CfnNotebookInstanceProps.Builder instanceMetadataServiceConfiguration(CfnNotebookInstance.InstanceMetadataServiceConfigurationProperty instanceMetadataServiceConfiguration)

Sets the value of CfnNotebookInstanceProps.getInstanceMetadataServiceConfiguration()

Parameters:

instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnNotebookInstanceProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnNotebookInstanceProps.getKmsKeyId()

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a AWS Key Management Service key that 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 .

Returns:

this

lifecycleConfigName

@Stability(Stable)
public CfnNotebookInstanceProps.Builder lifecycleConfigName(String lifecycleConfigName)

Sets the value of CfnNotebookInstanceProps.getLifecycleConfigName()

Parameters:

lifecycleConfigName - The name of a lifecycle configuration to associate with the notebook instance. For information about lifecycle configurations, see Customize a Notebook Instance in the Amazon SageMaker Developer Guide .

Returns:

this

notebookInstanceName

@Stability(Stable)
public CfnNotebookInstanceProps.Builder notebookInstanceName(String notebookInstanceName)

Sets the value of CfnNotebookInstanceProps.getNotebookInstanceName()

Parameters:

notebookInstanceName - The name of the new notebook instance.

Returns:

this

platformIdentifier

@Stability(Stable)
public CfnNotebookInstanceProps.Builder platformIdentifier(String platformIdentifier)

Sets the value of CfnNotebookInstanceProps.getPlatformIdentifier()

Parameters:

platformIdentifier - The platform identifier of the notebook instance runtime environment.

Returns:

this

rootAccess

@Stability(Stable)
public CfnNotebookInstanceProps.Builder rootAccess(String rootAccess)

Sets the value of CfnNotebookInstanceProps.getRootAccess()

Parameters:

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

Returns:

this

securityGroupIds

@Stability(Stable)
public CfnNotebookInstanceProps.Builder securityGroupIds(List<String> securityGroupIds)

Sets the value of CfnNotebookInstanceProps.getSecurityGroupIds()

Parameters:

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

Returns:

this

subnetId

@Stability(Stable)
public CfnNotebookInstanceProps.Builder subnetId(String subnetId)

Sets the value of CfnNotebookInstanceProps.getSubnetId()

Parameters:

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

Returns:

this

tags

@Stability(Stable)
public CfnNotebookInstanceProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnNotebookInstanceProps.getTags()

Parameters:

tags - A list of key-value pairs to apply to this resource. For more information, see Resource Tag and Using Cost Allocation Tags .

You can add tags later by using the CreateTags API.

Returns:

this

volumeSizeInGb

@Stability(Stable)
public CfnNotebookInstanceProps.Builder volumeSizeInGb(Number volumeSizeInGb)

Sets the value of CfnNotebookInstanceProps.getVolumeSizeInGb()

Parameters:

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

Expect some interruption of service if this parameter is changed as CloudFormation stops a notebook instance and starts it up again to update it.

Returns:

this

build

@Stability(Stable)
public CfnNotebookInstanceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnNotebookInstanceProps>

Returns:

a new instance of CfnNotebookInstanceProps

Throws:

NullPointerException - if any required attribute was not provided