Package software.amazon.awssdk.services.sagemaker.model

Class CreateNotebookInstanceRequest

    • Method Detail

      • notebookInstanceName

        public final String notebookInstanceName()

        The name of the new notebook instance.

        Returns:
        The name of the new notebook instance.

      • instanceType

        public final InstanceType instanceType()

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

        If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

        Returns:
        The type of ML compute instance to launch for the notebook instance.
        See Also:
        InstanceType

      • instanceTypeAsString

        public final String instanceTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

        Returns:
        The type of ML compute instance to launch for the notebook instance.
        See Also:
        InstanceType

      • subnetId

        public final String subnetId()

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

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

      • hasSecurityGroupIds

        public final boolean hasSecurityGroupIds()
        For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • securityGroupIds

        public final List<String> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

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

      • ipAddressType

        public final IPAddressType ipAddressType()

        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

        If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

        Returns:
        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.
        See Also:
        IPAddressType

      • ipAddressTypeAsString

        public final String ipAddressTypeAsString()

        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

        If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IPAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

        Returns:
        The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.
        See Also:
        IPAddressType

      • roleArn

        public final String roleArn()

        When you send any requests to Amazon Web Services 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:
        When you send any requests to Amazon Web Services 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.

      • kmsKeyId

        public final String kmsKeyId()

        The Amazon Resource Name (ARN) of a Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.

        Returns:
        The Amazon Resource Name (ARN) of a Amazon Web Services 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 Amazon Web Services Key Management Service Developer Guide.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

      • directInternetAccess

        public final DirectInternetAccess 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.

        If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

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

        See Also:
        DirectInternetAccess

      • directInternetAccessAsString

        public final String directInternetAccessAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, directInternetAccess will return DirectInternetAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directInternetAccessAsString().

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

        See Also:
        DirectInternetAccess

      • volumeSizeInGB

        public final Integer volumeSizeInGB()

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

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

      • acceleratorTypes

        public final List<NotebookInstanceAcceleratorType> acceleratorTypes()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of EI instance types to associate with this notebook instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

        Returns:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of EI instance types to associate with this notebook instance.

      • hasAcceleratorTypes

        public final boolean hasAcceleratorTypes()
        For responses, this returns true if the service returned a value for the AcceleratorTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • acceleratorTypesAsStrings

        public final List<String> acceleratorTypesAsStrings()

        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of EI instance types to associate with this notebook instance.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

        Returns:
        This parameter is no longer supported. Elastic Inference (EI) is no longer available.

        This parameter was used to specify a list of EI instance types to associate with this notebook instance.

      • defaultCodeRepository

        public final String defaultCodeRepository()

        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 SageMaker AI Notebook Instances.

        Returns:
        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 SageMaker AI Notebook Instances.

      • hasAdditionalCodeRepositories

        public final boolean hasAdditionalCodeRepositories()
        For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • additionalCodeRepositories

        public final List<String> additionalCodeRepositories()

        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 SageMaker AI Notebook Instances.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalCodeRepositories() method.

        Returns:
        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 SageMaker AI Notebook Instances.

      • rootAccess

        public final RootAccess 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.

        If the service returns an enum value that is not available in the current SDK version, rootAccess will return RootAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootAccessAsString().

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

        See Also:
        RootAccess

      • rootAccessAsString

        public final String rootAccessAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, rootAccess will return RootAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootAccessAsString().

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

        See Also:
        RootAccess

      • platformIdentifier

        public final String platformIdentifier()

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

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

      • instanceMetadataServiceConfiguration

        public final InstanceMetadataServiceConfiguration instanceMetadataServiceConfiguration()

        Information on the IMDS configuration of the notebook instance

        Returns:
        Information on the IMDS configuration of the notebook instance

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object