CfnSpacePropsMixin

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

Bases: Mixin

Creates a private space or a space used for real time collaboration in a domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html

CloudformationResource:

AWS::SageMaker::Space

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_space_props_mixin = sagemaker_mixins.CfnSpacePropsMixin(sagemaker_mixins.CfnSpaceMixinProps(
    domain_id="domainId",
    ownership_settings=sagemaker_mixins.CfnSpacePropsMixin.OwnershipSettingsProperty(
        owner_user_profile_name="ownerUserProfileName"
    ),
    space_display_name="spaceDisplayName",
    space_name="spaceName",
    space_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceSettingsProperty(
        app_type="appType",
        code_editor_app_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceCodeEditorAppSettingsProperty(
            app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
                idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
                    idle_timeout_in_minutes=123
                )
            ),
            default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            )
        ),
        custom_file_systems=[sagemaker_mixins.CfnSpacePropsMixin.CustomFileSystemProperty(
            efs_file_system=sagemaker_mixins.CfnSpacePropsMixin.EFSFileSystemProperty(
                file_system_id="fileSystemId"
            ),
            f_sx_lustre_file_system=sagemaker_mixins.CfnSpacePropsMixin.FSxLustreFileSystemProperty(
                file_system_id="fileSystemId"
            ),
            s3_file_system=sagemaker_mixins.CfnSpacePropsMixin.S3FileSystemProperty(
                s3_uri="s3Uri"
            )
        )],
        jupyter_lab_app_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceJupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
                idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
                    idle_timeout_in_minutes=123
                )
            ),
            code_repositories=[sagemaker_mixins.CfnSpacePropsMixin.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            )
        ),
        jupyter_server_app_settings=sagemaker_mixins.CfnSpacePropsMixin.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        kernel_gateway_app_settings=sagemaker_mixins.CfnSpacePropsMixin.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker_mixins.CfnSpacePropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        remote_access="remoteAccess",
        space_managed_resources="spaceManagedResources",
        space_storage_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceStorageSettingsProperty(
            ebs_storage_settings=sagemaker_mixins.CfnSpacePropsMixin.EbsStorageSettingsProperty(
                ebs_volume_size_in_gb=123
            )
        )
    ),
    space_sharing_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceSharingSettingsProperty(
        sharing_type="sharingType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnSpaceMixinProps, 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 = ['domainId', 'ownershipSettings', 'spaceDisplayName', 'spaceName', 'spaceSettings', 'spaceSharingSettings', 'tags']

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

CodeRepositoryProperty

class CfnSpacePropsMixin.CodeRepositoryProperty(*, repository_url=None)

Bases: object

A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.

Parameters:

repository_url (Optional[str]) – The URL of the Git repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-coderepository.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

code_repository_property = sagemaker_mixins.CfnSpacePropsMixin.CodeRepositoryProperty(
    repository_url="repositoryUrl"
)

Attributes

repository_url

The URL of the Git repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-coderepository.html#cfn-sagemaker-space-coderepository-repositoryurl

CustomFileSystemProperty

class CfnSpacePropsMixin.CustomFileSystemProperty(*, efs_file_system=None, f_sx_lustre_file_system=None, s3_file_system=None)

Bases: object

A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customfilesystem.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

custom_file_system_property = sagemaker_mixins.CfnSpacePropsMixin.CustomFileSystemProperty(
    efs_file_system=sagemaker_mixins.CfnSpacePropsMixin.EFSFileSystemProperty(
        file_system_id="fileSystemId"
    ),
    f_sx_lustre_file_system=sagemaker_mixins.CfnSpacePropsMixin.FSxLustreFileSystemProperty(
        file_system_id="fileSystemId"
    ),
    s3_file_system=sagemaker_mixins.CfnSpacePropsMixin.S3FileSystemProperty(
        s3_uri="s3Uri"
    )
)

Attributes

efs_file_system

A custom file system in Amazon EFS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customfilesystem.html#cfn-sagemaker-space-customfilesystem-efsfilesystem

f_sx_lustre_file_system

A custom file system in Amazon FSx for Lustre.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customfilesystem.html#cfn-sagemaker-space-customfilesystem-fsxlustrefilesystem

s3_file_system

A custom file system in Amazon S3.

This is only supported in Amazon SageMaker Unified Studio.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customfilesystem.html#cfn-sagemaker-space-customfilesystem-s3filesystem

CustomImageProperty

class CfnSpacePropsMixin.CustomImageProperty(*, app_image_config_name=None, image_name=None, image_version_number=None)

Bases: object

A custom SageMaker AI image.

For more information, see Bring your own SageMaker AI image .

Parameters:

  • app_image_config_name (Optional[str]) – The name of the AppImageConfig.

  • image_name (Optional[str]) – The name of the CustomImage. Must be unique to your account.

  • image_version_number (Union[int, float, None]) – The version number of the CustomImage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.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

custom_image_property = sagemaker_mixins.CfnSpacePropsMixin.CustomImageProperty(
    app_image_config_name="appImageConfigName",
    image_name="imageName",
    image_version_number=123
)

Attributes

app_image_config_name

The name of the AppImageConfig.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-appimageconfigname

image_name

The name of the CustomImage.

Must be unique to your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-imagename

image_version_number

The version number of the CustomImage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-customimage.html#cfn-sagemaker-space-customimage-imageversionnumber

EFSFileSystemProperty

class CfnSpacePropsMixin.EFSFileSystemProperty(*, file_system_id=None)

Bases: object

A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

Parameters:

file_system_id (Optional[str]) – The ID of your Amazon EFS file system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-efsfilesystem.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

e_fSFile_system_property = sagemaker_mixins.CfnSpacePropsMixin.EFSFileSystemProperty(
    file_system_id="fileSystemId"
)

Attributes

file_system_id

The ID of your Amazon EFS file system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-efsfilesystem.html#cfn-sagemaker-space-efsfilesystem-filesystemid

EbsStorageSettingsProperty

class CfnSpacePropsMixin.EbsStorageSettingsProperty(*, ebs_volume_size_in_gb=None)

Bases: object

A collection of EBS storage settings that apply to both private and shared spaces.

Parameters:

ebs_volume_size_in_gb (Union[int, float, None]) – The size of an EBS storage volume for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ebsstoragesettings.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

ebs_storage_settings_property = sagemaker_mixins.CfnSpacePropsMixin.EbsStorageSettingsProperty(
    ebs_volume_size_in_gb=123
)

Attributes

ebs_volume_size_in_gb

The size of an EBS storage volume for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ebsstoragesettings.html#cfn-sagemaker-space-ebsstoragesettings-ebsvolumesizeingb

FSxLustreFileSystemProperty

class CfnSpacePropsMixin.FSxLustreFileSystemProperty(*, file_system_id=None)

Bases: object

A custom file system in Amazon FSx for Lustre.

Parameters:

file_system_id (Optional[str]) – Amazon FSx for Lustre file system ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-fsxlustrefilesystem.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

f_sx_lustre_file_system_property = sagemaker_mixins.CfnSpacePropsMixin.FSxLustreFileSystemProperty(
    file_system_id="fileSystemId"
)

Attributes

file_system_id

Amazon FSx for Lustre file system ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-fsxlustrefilesystem.html#cfn-sagemaker-space-fsxlustrefilesystem-filesystemid

JupyterServerAppSettingsProperty

class CfnSpacePropsMixin.JupyterServerAppSettingsProperty(*, default_resource_spec=None, lifecycle_config_arns=None)

Bases: object

The JupyterServer app settings.

Parameters:

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

  • lifecycle_config_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required. .. epigraph:: To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-jupyterserverappsettings.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

jupyter_server_app_settings_property = sagemaker_mixins.CfnSpacePropsMixin.JupyterServerAppSettingsProperty(
    default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    lifecycle_config_arns=["lifecycleConfigArns"]
)

Attributes

default_resource_spec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the JupyterServer app.

If you use the LifecycleConfigArns parameter, then this parameter is also required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-jupyterserverappsettings.html#cfn-sagemaker-space-jupyterserverappsettings-defaultresourcespec

lifecycle_config_arns

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp.

If you use this parameter, the DefaultResourceSpec parameter is also required. .. epigraph:

To remove a Lifecycle Config, you must set ``LifecycleConfigArns`` to an empty list.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-jupyterserverappsettings.html#cfn-sagemaker-space-jupyterserverappsettings-lifecycleconfigarns

KernelGatewayAppSettingsProperty

class CfnSpacePropsMixin.KernelGatewayAppSettingsProperty(*, custom_images=None, default_resource_spec=None, lifecycle_config_arns=None)

Bases: object

The KernelGateway app settings.

Parameters:

  • custom_images (Union[IResolvable, Sequence[Union[IResolvable, CustomImageProperty, Dict[str, Any]]], None]) – A list of custom SageMaker AI images that are configured to run as a KernelGateway app. The maximum number of custom images are as follows. - On a domain level: 200 - On a space level: 5 - On a user profile level: 5

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app. .. epigraph:: The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not passed.

  • lifecycle_config_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain. .. epigraph:: To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.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

kernel_gateway_app_settings_property = sagemaker_mixins.CfnSpacePropsMixin.KernelGatewayAppSettingsProperty(
    custom_images=[sagemaker_mixins.CfnSpacePropsMixin.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",
        image_version_number=123
    )],
    default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    lifecycle_config_arns=["lifecycleConfigArns"]
)

Attributes

custom_images

A list of custom SageMaker AI images that are configured to run as a KernelGateway app.

The maximum number of custom images are as follows.

  • On a domain level: 200

  • On a space level: 5

  • On a user profile level: 5

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-customimages

default_resource_spec

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.

The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or CloudFormation and the instance type parameter value is not passed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-defaultresourcespec

lifecycle_config_arns

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-kernelgatewayappsettings.html#cfn-sagemaker-space-kernelgatewayappsettings-lifecycleconfigarns

OwnershipSettingsProperty

class CfnSpacePropsMixin.OwnershipSettingsProperty(*, owner_user_profile_name=None)

Bases: object

The collection of ownership settings for a space.

Parameters:

owner_user_profile_name (Optional[str]) – The user profile who is the owner of the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ownershipsettings.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

ownership_settings_property = sagemaker_mixins.CfnSpacePropsMixin.OwnershipSettingsProperty(
    owner_user_profile_name="ownerUserProfileName"
)

Attributes

owner_user_profile_name

The user profile who is the owner of the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-ownershipsettings.html#cfn-sagemaker-space-ownershipsettings-owneruserprofilename

ResourceSpecProperty

class CfnSpacePropsMixin.ResourceSpecProperty(*, instance_type=None, lifecycle_config_arn=None, sage_maker_image_arn=None, sage_maker_image_version_arn=None)

Bases: object

Specifies the ARN’s of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.

When both SageMakerImageVersionArn and SageMakerImageArn are passed, SageMakerImageVersionArn is used. Any updates to SageMakerImageArn will not take effect if SageMakerImageVersionArn already exists in the ResourceSpec because SageMakerImageVersionArn always takes precedence. To clear the value set for SageMakerImageVersionArn , pass None as the value.

Parameters:

  • instance_type (Optional[str]) – The instance type that the image version runs on. .. epigraph:: JupyterServer apps only support the system value. For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

  • lifecycle_config_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

  • sage_maker_image_arn (Optional[str]) – The ARN of the SageMaker AI image that the image version belongs to.

  • sage_maker_image_version_arn (Optional[str]) – The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn , pass None as the value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.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

resource_spec_property = sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
    instance_type="instanceType",
    lifecycle_config_arn="lifecycleConfigArn",
    sage_maker_image_arn="sageMakerImageArn",
    sage_maker_image_version_arn="sageMakerImageVersionArn"
)

Attributes

instance_type

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-instancetype

lifecycle_config_arn

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-lifecycleconfigarn

sage_maker_image_arn

The ARN of the SageMaker AI image that the image version belongs to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimagearn

sage_maker_image_version_arn

The ARN of the image version created on the instance.

To clear the value set for SageMakerImageVersionArn , pass None as the value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-resourcespec.html#cfn-sagemaker-space-resourcespec-sagemakerimageversionarn

S3FileSystemProperty

class CfnSpacePropsMixin.S3FileSystemProperty(*, s3_uri=None)

Bases: object

A custom file system in Amazon S3.

This is only supported in Amazon SageMaker Unified Studio.

Parameters:

s3_uri (Optional[str]) – The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment. For example: s3://<bucket-name>/<prefix>/ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-s3filesystem.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

s3_file_system_property = sagemaker_mixins.CfnSpacePropsMixin.S3FileSystemProperty(
    s3_uri="s3Uri"
)

Attributes

s3_uri

The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment.

For example: s3://<bucket-name>/<prefix>/ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-s3filesystem.html#cfn-sagemaker-space-s3filesystem-s3uri

SpaceAppLifecycleManagementProperty

class CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(*, idle_settings=None)

Bases: object

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

Parameters:

idle_settings (Union[IResolvable, SpaceIdleSettingsProperty, Dict[str, Any], None]) – Settings related to idle shutdown of Studio applications.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceapplifecyclemanagement.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

space_app_lifecycle_management_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
    idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
        idle_timeout_in_minutes=123
    )
)

Attributes

idle_settings

Settings related to idle shutdown of Studio applications.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceapplifecyclemanagement.html#cfn-sagemaker-space-spaceapplifecyclemanagement-idlesettings

SpaceCodeEditorAppSettingsProperty

class CfnSpacePropsMixin.SpaceCodeEditorAppSettingsProperty(*, app_lifecycle_management=None, default_resource_spec=None)

Bases: object

The application settings for a Code Editor space.

Parameters:

  • app_lifecycle_management (Union[IResolvable, SpaceAppLifecycleManagementProperty, Dict[str, Any], None]) – Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.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

space_code_editor_app_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceCodeEditorAppSettingsProperty(
    app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
        idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
            idle_timeout_in_minutes=123
        )
    ),
    default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    )
)

Attributes

app_lifecycle_management

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html#cfn-sagemaker-space-spacecodeeditorappsettings-applifecyclemanagement

default_resource_spec

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacecodeeditorappsettings.html#cfn-sagemaker-space-spacecodeeditorappsettings-defaultresourcespec

SpaceIdleSettingsProperty

class CfnSpacePropsMixin.SpaceIdleSettingsProperty(*, idle_timeout_in_minutes=None)

Bases: object

Settings related to idle shutdown of Studio applications in a space.

Parameters:

idle_timeout_in_minutes (Union[int, float, None]) – The time that SageMaker waits after the application becomes idle before shutting it down.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceidlesettings.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

space_idle_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
    idle_timeout_in_minutes=123
)

Attributes

idle_timeout_in_minutes

The time that SageMaker waits after the application becomes idle before shutting it down.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spaceidlesettings.html#cfn-sagemaker-space-spaceidlesettings-idletimeoutinminutes

SpaceJupyterLabAppSettingsProperty

class CfnSpacePropsMixin.SpaceJupyterLabAppSettingsProperty(*, app_lifecycle_management=None, code_repositories=None, default_resource_spec=None)

Bases: object

The settings for the JupyterLab application within a space.

Parameters:

  • app_lifecycle_management (Union[IResolvable, SpaceAppLifecycleManagementProperty, Dict[str, Any], None]) – Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

  • code_repositories (Union[IResolvable, Sequence[Union[IResolvable, CodeRepositoryProperty, Dict[str, Any]]], None]) – A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.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

space_jupyter_lab_app_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceJupyterLabAppSettingsProperty(
    app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
        idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
            idle_timeout_in_minutes=123
        )
    ),
    code_repositories=[sagemaker_mixins.CfnSpacePropsMixin.CodeRepositoryProperty(
        repository_url="repositoryUrl"
    )],
    default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    )
)

Attributes

app_lifecycle_management

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-applifecyclemanagement

code_repositories

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-coderepositories

default_resource_spec

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacejupyterlabappsettings.html#cfn-sagemaker-space-spacejupyterlabappsettings-defaultresourcespec

SpaceSettingsProperty

class CfnSpacePropsMixin.SpaceSettingsProperty(*, app_type=None, code_editor_app_settings=None, custom_file_systems=None, jupyter_lab_app_settings=None, jupyter_server_app_settings=None, kernel_gateway_app_settings=None, remote_access=None, space_managed_resources=None, space_storage_settings=None)

Bases: object

A collection of space settings.

Parameters:

  • app_type (Optional[str]) – The type of app created within the space. If using the UpdateSpace API, you can’t change the app type of your space by specifying a different value for this field.

  • code_editor_app_settings (Union[IResolvable, SpaceCodeEditorAppSettingsProperty, Dict[str, Any], None]) – The Code Editor application settings.

  • custom_file_systems (Union[IResolvable, Sequence[Union[IResolvable, CustomFileSystemProperty, Dict[str, Any]]], None]) – A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

  • jupyter_lab_app_settings (Union[IResolvable, SpaceJupyterLabAppSettingsProperty, Dict[str, Any], None]) – The settings for the JupyterLab application.

  • jupyter_server_app_settings (Union[IResolvable, JupyterServerAppSettingsProperty, Dict[str, Any], None]) – The JupyterServer app settings.

  • kernel_gateway_app_settings (Union[IResolvable, KernelGatewayAppSettingsProperty, Dict[str, Any], None]) – The KernelGateway app settings.

  • remote_access (Optional[str]) – A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

  • space_managed_resources (Optional[str]) – If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:. - The user profile that possesses the space. - The app that the space contains.

  • space_storage_settings (Union[IResolvable, SpaceStorageSettingsProperty, Dict[str, Any], None]) – The storage settings for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.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

space_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceSettingsProperty(
    app_type="appType",
    code_editor_app_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceCodeEditorAppSettingsProperty(
        app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
            idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
                idle_timeout_in_minutes=123
            )
        ),
        default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        )
    ),
    custom_file_systems=[sagemaker_mixins.CfnSpacePropsMixin.CustomFileSystemProperty(
        efs_file_system=sagemaker_mixins.CfnSpacePropsMixin.EFSFileSystemProperty(
            file_system_id="fileSystemId"
        ),
        f_sx_lustre_file_system=sagemaker_mixins.CfnSpacePropsMixin.FSxLustreFileSystemProperty(
            file_system_id="fileSystemId"
        ),
        s3_file_system=sagemaker_mixins.CfnSpacePropsMixin.S3FileSystemProperty(
            s3_uri="s3Uri"
        )
    )],
    jupyter_lab_app_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceJupyterLabAppSettingsProperty(
        app_lifecycle_management=sagemaker_mixins.CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty(
            idle_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceIdleSettingsProperty(
                idle_timeout_in_minutes=123
            )
        ),
        code_repositories=[sagemaker_mixins.CfnSpacePropsMixin.CodeRepositoryProperty(
            repository_url="repositoryUrl"
        )],
        default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        )
    ),
    jupyter_server_app_settings=sagemaker_mixins.CfnSpacePropsMixin.JupyterServerAppSettingsProperty(
        default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    kernel_gateway_app_settings=sagemaker_mixins.CfnSpacePropsMixin.KernelGatewayAppSettingsProperty(
        custom_images=[sagemaker_mixins.CfnSpacePropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnSpacePropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    remote_access="remoteAccess",
    space_managed_resources="spaceManagedResources",
    space_storage_settings=sagemaker_mixins.CfnSpacePropsMixin.SpaceStorageSettingsProperty(
        ebs_storage_settings=sagemaker_mixins.CfnSpacePropsMixin.EbsStorageSettingsProperty(
            ebs_volume_size_in_gb=123
        )
    )
)

Attributes

app_type

The type of app created within the space.

If using the UpdateSpace API, you can’t change the app type of your space by specifying a different value for this field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-apptype

code_editor_app_settings

The Code Editor application settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-codeeditorappsettings

custom_file_systems

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-customfilesystems

jupyter_lab_app_settings

The settings for the JupyterLab application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterlabappsettings

jupyter_server_app_settings

The JupyterServer app settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-jupyterserverappsettings

kernel_gateway_app_settings

The KernelGateway app settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-kernelgatewayappsettings

remote_access

A setting that enables or disables remote access for a SageMaker space.

When enabled, this allows you to connect to the remote space from your local IDE.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-remoteaccess

space_managed_resources

.

  • The user profile that possesses the space.

  • The app that the space contains.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacemanagedresources

Type:

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space

space_storage_settings

The storage settings for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesettings.html#cfn-sagemaker-space-spacesettings-spacestoragesettings

SpaceSharingSettingsProperty

class CfnSpacePropsMixin.SpaceSharingSettingsProperty(*, sharing_type=None)

Bases: object

A collection of space sharing settings.

Parameters:

sharing_type (Optional[str]) – Specifies the sharing type of the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesharingsettings.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

space_sharing_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceSharingSettingsProperty(
    sharing_type="sharingType"
)

Attributes

sharing_type

Specifies the sharing type of the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacesharingsettings.html#cfn-sagemaker-space-spacesharingsettings-sharingtype

SpaceStorageSettingsProperty

class CfnSpacePropsMixin.SpaceStorageSettingsProperty(*, ebs_storage_settings=None)

Bases: object

The storage settings for a space.

Parameters:

ebs_storage_settings (Union[IResolvable, EbsStorageSettingsProperty, Dict[str, Any], None]) – A collection of EBS storage settings for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacestoragesettings.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

space_storage_settings_property = sagemaker_mixins.CfnSpacePropsMixin.SpaceStorageSettingsProperty(
    ebs_storage_settings=sagemaker_mixins.CfnSpacePropsMixin.EbsStorageSettingsProperty(
        ebs_volume_size_in_gb=123
    )
)

Attributes

ebs_storage_settings

A collection of EBS storage settings for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-space-spacestoragesettings.html#cfn-sagemaker-space-spacestoragesettings-ebsstoragesettings