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

Class CfnNotebookInstanceMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnNotebookInstanceMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnNotebookInstanceMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnNotebookInstanceMixinProps

@Stability(Stable)
@Internal
public static final class CfnNotebookInstanceMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnNotebookInstanceMixinProps

An implementation for CfnNotebookInstanceMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnNotebookInstanceMixinProps

CfnNotebookInstanceMixinProps.Builder, CfnNotebookInstanceMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnNotebookInstanceMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnNotebookInstanceMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAcceleratorTypes()	A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.
final List<String>	getAdditionalCodeRepositories()	An array of up to three Git repositories associated with the notebook instance.
final String	getDefaultCodeRepository()	The Git repository associated with the notebook instance as its default code repository.
final String	getDirectInternetAccess()	Sets whether SageMaker AI provides internet access to the notebook instance.
final Object	getInstanceMetadataServiceConfiguration()	Information on the IMDS configuration of the notebook instance.
final String	getInstanceType()	The type of ML compute instance to launch for the notebook instance.
final String	getKmsKeyId()	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.
final String	getLifecycleConfigName()	The name of a lifecycle configuration to associate with the notebook instance.
final String	getNotebookInstanceName()	The name of the new notebook instance.
final String	getPlatformIdentifier()	The platform identifier of the notebook instance runtime environment.
final String	getRoleArn()	When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf.
final String	getRootAccess()	Whether root access is enabled or disabled for users of the notebook instance.
final List<String>	getSecurityGroupIds()	The VPC security group IDs, in the form sg-xxxxxxxx.
final String	getSubnetId()	The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.
final List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.
final Number	getVolumeSizeInGb()	The size, in GB, of the ML storage volume to attach to the notebook instance.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnNotebookInstanceMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnNotebookInstanceMixinProps.Builder.

Method Details

getAcceleratorTypes

public final List<String> getAcceleratorTypes()

Description copied from interface: CfnNotebookInstanceMixinProps

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 .

Specified by:

getAcceleratorTypes in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-acceleratortypes

getAdditionalCodeRepositories

public final List<String> getAdditionalCodeRepositories()

Description copied from interface: CfnNotebookInstanceMixinProps

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 .

Specified by:

getAdditionalCodeRepositories in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-additionalcoderepositories

getDefaultCodeRepository

public final String getDefaultCodeRepository()

Description copied from interface: CfnNotebookInstanceMixinProps

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 .

Specified by:

getDefaultCodeRepository in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-defaultcoderepository

getDirectInternetAccess

public final String getDirectInternetAccess()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getDirectInternetAccess in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-directinternetaccess

getInstanceMetadataServiceConfiguration

public final Object getInstanceMetadataServiceConfiguration()

Description copied from interface: CfnNotebookInstanceMixinProps

Information on the IMDS configuration of the notebook instance.

Returns union: either IResolvable or CfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty

Specified by:

getInstanceMetadataServiceConfiguration in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration

getInstanceType

public final String getInstanceType()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getInstanceType in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-instancetype

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnNotebookInstanceMixinProps

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 .

Specified by:

getKmsKeyId in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-kmskeyid

getLifecycleConfigName

public final String getLifecycleConfigName()

Description copied from interface: CfnNotebookInstanceMixinProps

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 .

Specified by:

getLifecycleConfigName in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-lifecycleconfigname

getNotebookInstanceName

public final String getNotebookInstanceName()

Description copied from interface: CfnNotebookInstanceMixinProps

The name of the new notebook instance.

Specified by:

getNotebookInstanceName in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-notebookinstancename

getPlatformIdentifier

public final String getPlatformIdentifier()

Description copied from interface: CfnNotebookInstanceMixinProps

The platform identifier of the notebook instance runtime environment.

The default value is notebook-al2-v2 .

Specified by:

getPlatformIdentifier in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-platformidentifier

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getRoleArn in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rolearn

getRootAccess

public final String getRootAccess()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getRootAccess in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-rootaccess

getSecurityGroupIds

public final List<String> getSecurityGroupIds()

Description copied from interface: CfnNotebookInstanceMixinProps

The VPC security group IDs, in the form sg-xxxxxxxx.

The security groups must be for the same VPC as specified in the subnet.

Specified by:

getSecurityGroupIds in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-securitygroupids

getSubnetId

public final String getSubnetId()

Description copied from interface: CfnNotebookInstanceMixinProps

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

Specified by:

getSubnetId in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-subnetid

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getTags in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-tags

getVolumeSizeInGb

public final Number getVolumeSizeInGb()

Description copied from interface: CfnNotebookInstanceMixinProps

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.

Specified by:

getVolumeSizeInGb in interface CfnNotebookInstanceMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html#cfn-sagemaker-notebookinstance-volumesizeingb

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object