CfnNotebookInstancePropsMixin

class aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnNotebookInstancePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SageMaker::NotebookInstance resource creates an Amazon SageMaker notebook instance.

A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-notebookinstance.html
CloudformationResource:: AWS::SageMaker::NotebookInstance
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_sagemaker import mixins as sagemaker_mixins

cfn_notebook_instance_props_mixin = sagemaker_mixins.CfnNotebookInstancePropsMixin(sagemaker_mixins.CfnNotebookInstanceMixinProps(
    accelerator_types=["acceleratorTypes"],
    additional_code_repositories=["additionalCodeRepositories"],
    default_code_repository="defaultCodeRepository",
    direct_internet_access="directInternetAccess",
    instance_metadata_service_configuration=sagemaker_mixins.CfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty(
        minimum_instance_metadata_service_version="minimumInstanceMetadataServiceVersion"
    ),
    instance_type="instanceType",
    kms_key_id="kmsKeyId",
    lifecycle_config_name="lifecycleConfigName",
    notebook_instance_name="notebookInstanceName",
    platform_identifier="platformIdentifier",
    role_arn="roleArn",
    root_access="rootAccess",
    security_group_ids=["securityGroupIds"],
    subnet_id="subnetId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    volume_size_in_gb=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SageMaker::NotebookInstance.

Parameters:

props (Union[CfnNotebookInstanceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['acceleratorTypes', 'additionalCodeRepositories', 'defaultCodeRepository', 'directInternetAccess', 'instanceMetadataServiceConfiguration', 'instanceType', 'kmsKeyId', 'lifecycleConfigName', 'notebookInstanceName', 'platformIdentifier', 'roleArn', 'rootAccess', 'securityGroupIds', 'subnetId', 'tags', 'volumeSizeInGb']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

InstanceMetadataServiceConfigurationProperty

class CfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty(*, minimum_instance_metadata_service_version=None)

Bases: object

Information on the IMDS configuration of the notebook instance.

Parameters:: minimum_instance_metadata_service_version (Optional[str]) – Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance , if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance , there is no default.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstance-instancemetadataserviceconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_sagemaker import mixins as sagemaker_mixins

instance_metadata_service_configuration_property = sagemaker_mixins.CfnNotebookInstancePropsMixin.InstanceMetadataServiceConfigurationProperty(
    minimum_instance_metadata_service_version="minimumInstanceMetadataServiceVersion"
)

Attributes

minimum_instance_metadata_service_version

Indicates the minimum IMDS version that the notebook instance supports.

When passed as part of CreateNotebookInstance , if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance , there is no default.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-notebookinstance-instancemetadataserviceconfiguration.html#cfn-sagemaker-notebookinstance-instancemetadataserviceconfiguration-minimuminstancemetadataserviceversion