Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnNotebookInstanceMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnNotebookInstanceMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNotebookInstanceMixinProps>

Enclosing interface:

CfnNotebookInstanceMixinProps

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

A builder for CfnNotebookInstanceMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

acceleratorTypes

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

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder additionalCodeRepositories(List<String> additionalCodeRepositories)

Sets the value of CfnNotebookInstanceMixinProps.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 AI Notebook Instances .

Returns:

this

defaultCodeRepository

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

Sets the value of CfnNotebookInstanceMixinProps.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 AI Notebook Instances .

Returns:

this

directInternetAccess

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

Sets the value of CfnNotebookInstanceMixinProps.getDirectInternetAccess()

Parameters:

directInternetAccess - Sets whether SageMaker AI 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 AI 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 CfnNotebookInstanceMixinProps.Builder instanceMetadataServiceConfiguration(IResolvable instanceMetadataServiceConfiguration)

Sets the value of CfnNotebookInstanceMixinProps.getInstanceMetadataServiceConfiguration()

Parameters:

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

Returns:

this

instanceMetadataServiceConfiguration

@Stability(Stable)
public CfnNotebookInstanceMixinProps.Builder instanceMetadataServiceConfiguration(CfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty instanceMetadataServiceConfiguration)

Sets the value of CfnNotebookInstanceMixinProps.getInstanceMetadataServiceConfiguration()

Parameters:

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

Returns:

this

instanceType

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

Sets the value of CfnNotebookInstanceMixinProps.getInstanceType()

Parameters:

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

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

kmsKeyId

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

Sets the value of CfnNotebookInstanceMixinProps.getKmsKeyId()

Parameters:

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

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder notebookInstanceName(String notebookInstanceName)

Sets the value of CfnNotebookInstanceMixinProps.getNotebookInstanceName()

Parameters:

notebookInstanceName - The name of the new notebook instance.

Returns:

this

platformIdentifier

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

Sets the value of CfnNotebookInstanceMixinProps.getPlatformIdentifier()

Parameters:

platformIdentifier - The platform identifier of the notebook instance runtime environment. The default value is notebook-al2-v2 .

Returns:

this

roleArn

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

Sets the value of CfnNotebookInstanceMixinProps.getRoleArn()

Parameters:

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

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

Returns:

this

rootAccess

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

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder securityGroupIds(List<String> securityGroupIds)

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder subnetId(String subnetId)

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps.Builder volumeSizeInGb(Number volumeSizeInGb)

Sets the value of CfnNotebookInstanceMixinProps.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 CfnNotebookInstanceMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnNotebookInstanceMixinProps

Throws:

NullPointerException - if any required attribute was not provided