Class CfnNotebookInstanceMixinProps.Jsii$Proxy
- All Implemented Interfaces:
CfnNotebookInstanceMixinProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnNotebookInstanceMixinProps
CfnNotebookInstanceMixinProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnNotebookInstanceMixinProps
CfnNotebookInstanceMixinProps.Builder, CfnNotebookInstanceMixinProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnNotebookInstanceMixinProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanA list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.An array of up to three Git repositories associated with the notebook instance.final StringThe Git repository associated with the notebook instance as its default code repository.final StringSets whether SageMaker AI provides internet access to the notebook instance.final ObjectInformation on the IMDS configuration of the notebook instance.final StringThe type of ML compute instance to launch for the notebook instance.final StringThe 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 StringThe name of a lifecycle configuration to associate with the notebook instance.final StringThe name of the new notebook instance.final StringThe platform identifier of the notebook instance runtime environment.final StringWhen you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf.final StringWhether root access is enabled or disabled for users of the notebook instance.The VPC security group IDs, in the form sg-xxxxxxxx.final StringThe ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.getTags()A list of key-value pairs to apply to this resource.final NumberThe size, in GB, of the ML storage volume to attach to the notebook instance.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theCfnNotebookInstanceMixinProps.Builder.
-
-
Method Details
-
getAcceleratorTypes
Description copied from interface:CfnNotebookInstanceMixinPropsA 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:
getAcceleratorTypesin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getAdditionalCodeRepositories
Description copied from interface:CfnNotebookInstanceMixinPropsAn 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:
getAdditionalCodeRepositoriesin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getDefaultCodeRepository
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getDefaultCodeRepositoryin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getDirectInternetAccess
Description copied from interface:CfnNotebookInstanceMixinPropsSets whether SageMaker AI provides internet access to the notebook instance.If you set this to
Disabledthis 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
Disabledonly if you set a value for theSubnetIdparameter.- Specified by:
getDirectInternetAccessin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getInstanceMetadataServiceConfiguration
Description copied from interface:CfnNotebookInstanceMixinPropsInformation on the IMDS configuration of the notebook instance.Returns union: either
IResolvableorCfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty- Specified by:
getInstanceMetadataServiceConfigurationin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getInstanceType
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getInstanceTypein interfaceCfnNotebookInstanceMixinProps- See Also:
-
getKmsKeyId
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getKmsKeyIdin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getLifecycleConfigName
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getLifecycleConfigNamein interfaceCfnNotebookInstanceMixinProps- See Also:
-
getNotebookInstanceName
Description copied from interface:CfnNotebookInstanceMixinPropsThe name of the new notebook instance.- Specified by:
getNotebookInstanceNamein interfaceCfnNotebookInstanceMixinProps- See Also:
-
getPlatformIdentifier
Description copied from interface:CfnNotebookInstanceMixinPropsThe platform identifier of the notebook instance runtime environment.The default value is
notebook-al2-v2.- Specified by:
getPlatformIdentifierin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getRoleArn
Description copied from interface:CfnNotebookInstanceMixinPropsWhen 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:PassRolepermission.- Specified by:
getRoleArnin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getRootAccess
Description copied from interface:CfnNotebookInstanceMixinPropsWhether root access is enabled or disabled for users of the notebook instance. The default value isEnabled.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:
getRootAccessin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getSecurityGroupIds
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getSecurityGroupIdsin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getSubnetId
Description copied from interface:CfnNotebookInstanceMixinPropsThe ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.- Specified by:
getSubnetIdin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getTags
Description copied from interface:CfnNotebookInstanceMixinPropsA 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
CreateTagsAPI.- Specified by:
getTagsin interfaceCfnNotebookInstanceMixinProps- See Also:
-
getVolumeSizeInGb
Description copied from interface:CfnNotebookInstanceMixinPropsThe 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:
getVolumeSizeInGbin interfaceCfnNotebookInstanceMixinProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-