CfnSpace

class aws_cdk.aws_sagemaker.CfnSpace(scope, id, *, domain_id, space_name, ownership_settings=None, space_display_name=None, space_settings=None, space_sharing_settings=None, tags=None)

Bases: CfnResource

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

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 import aws_sagemaker as sagemaker

cfn_space = sagemaker.CfnSpace(self, "MyCfnSpace",
    domain_id="domainId",
    space_name="spaceName",

    # the properties below are optional
    ownership_settings=sagemaker.CfnSpace.OwnershipSettingsProperty(
        owner_user_profile_name="ownerUserProfileName"
    ),
    space_display_name="spaceDisplayName",
    space_settings=sagemaker.CfnSpace.SpaceSettingsProperty(
        app_type="appType",
        code_editor_app_settings=sagemaker.CfnSpace.SpaceCodeEditorAppSettingsProperty(
            app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
                idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
                    idle_timeout_in_minutes=123
                )
            ),
            default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            )
        ),
        custom_file_systems=[sagemaker.CfnSpace.CustomFileSystemProperty(
            efs_file_system=sagemaker.CfnSpace.EFSFileSystemProperty(
                file_system_id="fileSystemId"
            )
        )],
        jupyter_lab_app_settings=sagemaker.CfnSpace.SpaceJupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
                idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
                    idle_timeout_in_minutes=123
                )
            ),
            code_repositories=[sagemaker.CfnSpace.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            )
        ),
        jupyter_server_app_settings=sagemaker.CfnSpace.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker.CfnSpace.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.CfnSpace.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker.CfnSpace.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        space_storage_settings=sagemaker.CfnSpace.SpaceStorageSettingsProperty(
            ebs_storage_settings=sagemaker.CfnSpace.EbsStorageSettingsProperty(
                ebs_volume_size_in_gb=123
            )
        )
    ),
    space_sharing_settings=sagemaker.CfnSpace.SpaceSharingSettingsProperty(
        sharing_type="sharingType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • domain_id (str) – The ID of the associated domain.

  • space_name (str) – The name of the space.

  • ownership_settings (Union[IResolvable, OwnershipSettingsProperty, Dict[str, Any], None]) – The collection of ownership settings for a space.

  • space_display_name (Optional[str]) – The name of the space that appears in the Studio UI.

  • space_settings (Union[IResolvable, SpaceSettingsProperty, Dict[str, Any], None]) – A collection of space settings.

  • space_sharing_settings (Union[IResolvable, SpaceSharingSettingsProperty, Dict[str, Any], None]) – A collection of space sharing settings.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SageMaker::Space'
attr_space_arn

The space’s Amazon Resource Name (ARN).

CloudformationAttribute:

SpaceArn

attr_url

Returns the URL of the space.

If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center.

The following application types are supported:

  • Studio Classic: &redirect=JupyterServer

  • JupyterLab: &redirect=JupyterLab

  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

CloudformationAttribute:

Url

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

domain_id

The ID of the associated domain.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ownership_settings

The collection of ownership settings for a space.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

space_display_name

The name of the space that appears in the Studio UI.

space_name

The name of the space.

space_settings

A collection of space settings.

space_sharing_settings

A collection of space sharing settings.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

An array of key-value pairs to apply to this resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

CodeRepositoryProperty

class CfnSpace.CodeRepositoryProperty(*, repository_url)

Bases: object

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

Parameters:

repository_url (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 import aws_sagemaker as sagemaker

code_repository_property = sagemaker.CfnSpace.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 CfnSpace.CustomFileSystemProperty(*, efs_file_system=None)

Bases: object

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

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

Parameters:

efs_file_system (Union[IResolvable, EFSFileSystemProperty, Dict[str, Any], None]) – A custom file system in Amazon EFS.

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 import aws_sagemaker as sagemaker

custom_file_system_property = sagemaker.CfnSpace.CustomFileSystemProperty(
    efs_file_system=sagemaker.CfnSpace.EFSFileSystemProperty(
        file_system_id="fileSystemId"
    )
)

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

CustomImageProperty

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

Bases: object

A custom SageMaker image.

For more information, see Bring your own SageMaker image .

Parameters:

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

  • image_name (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 import aws_sagemaker as sagemaker

custom_image_property = sagemaker.CfnSpace.CustomImageProperty(
    app_image_config_name="appImageConfigName",
    image_name="imageName",

    # the properties below are optional
    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 CfnSpace.EFSFileSystemProperty(*, file_system_id)

Bases: object

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

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

Parameters:

file_system_id (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 import aws_sagemaker as sagemaker

e_fSFile_system_property = sagemaker.CfnSpace.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 CfnSpace.EbsStorageSettingsProperty(*, ebs_volume_size_in_gb)

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]) – 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 import aws_sagemaker as sagemaker

ebs_storage_settings_property = sagemaker.CfnSpace.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

JupyterServerAppSettingsProperty

class CfnSpace.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 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 import aws_sagemaker as sagemaker

jupyter_server_app_settings_property = sagemaker.CfnSpace.JupyterServerAppSettingsProperty(
    default_resource_spec=sagemaker.CfnSpace.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 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 CfnSpace.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 images that are configured to run as a KernelGateway app.

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. .. epigraph:: The Amazon SageMaker 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 AWS 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 import aws_sagemaker as sagemaker

kernel_gateway_app_settings_property = sagemaker.CfnSpace.KernelGatewayAppSettingsProperty(
    custom_images=[sagemaker.CfnSpace.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",

        # the properties below are optional
        image_version_number=123
    )],
    default_resource_spec=sagemaker.CfnSpace.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 images that are configured to run as a KernelGateway app.

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 image used by the KernelGateway app.

The Amazon SageMaker 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 AWS 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 CfnSpace.OwnershipSettingsProperty(*, owner_user_profile_name)

Bases: object

The collection of ownership settings for a space.

Parameters:

owner_user_profile_name (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 import aws_sagemaker as sagemaker

ownership_settings_property = sagemaker.CfnSpace.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 CfnSpace.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 image and SageMaker image version, and the instance type that the version runs on.

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 image that the image version belongs to.

  • sage_maker_image_version_arn (Optional[str]) – The ARN of the image version created on the instance.

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 import aws_sagemaker as sagemaker

resource_spec_property = sagemaker.CfnSpace.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 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.

See:

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

SpaceAppLifecycleManagementProperty

class CfnSpace.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 import aws_sagemaker as sagemaker

space_app_lifecycle_management_property = sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
    idle_settings=sagemaker.CfnSpace.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 CfnSpace.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 import aws_sagemaker as sagemaker

space_code_editor_app_settings_property = sagemaker.CfnSpace.SpaceCodeEditorAppSettingsProperty(
    app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
        idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
            idle_timeout_in_minutes=123
        )
    ),
    default_resource_spec=sagemaker.CfnSpace.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 CfnSpace.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 import aws_sagemaker as sagemaker

space_idle_settings_property = sagemaker.CfnSpace.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 CfnSpace.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 import aws_sagemaker as sagemaker

space_jupyter_lab_app_settings_property = sagemaker.CfnSpace.SpaceJupyterLabAppSettingsProperty(
    app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
        idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
            idle_timeout_in_minutes=123
        )
    ),
    code_repositories=[sagemaker.CfnSpace.CodeRepositoryProperty(
        repository_url="repositoryUrl"
    )],
    default_resource_spec=sagemaker.CfnSpace.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 CfnSpace.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, space_storage_settings=None)

Bases: object

A collection of space settings.

Parameters:
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 import aws_sagemaker as sagemaker

space_settings_property = sagemaker.CfnSpace.SpaceSettingsProperty(
    app_type="appType",
    code_editor_app_settings=sagemaker.CfnSpace.SpaceCodeEditorAppSettingsProperty(
        app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
            idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
                idle_timeout_in_minutes=123
            )
        ),
        default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        )
    ),
    custom_file_systems=[sagemaker.CfnSpace.CustomFileSystemProperty(
        efs_file_system=sagemaker.CfnSpace.EFSFileSystemProperty(
            file_system_id="fileSystemId"
        )
    )],
    jupyter_lab_app_settings=sagemaker.CfnSpace.SpaceJupyterLabAppSettingsProperty(
        app_lifecycle_management=sagemaker.CfnSpace.SpaceAppLifecycleManagementProperty(
            idle_settings=sagemaker.CfnSpace.SpaceIdleSettingsProperty(
                idle_timeout_in_minutes=123
            )
        ),
        code_repositories=[sagemaker.CfnSpace.CodeRepositoryProperty(
            repository_url="repositoryUrl"
        )],
        default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        )
    ),
    jupyter_server_app_settings=sagemaker.CfnSpace.JupyterServerAppSettingsProperty(
        default_resource_spec=sagemaker.CfnSpace.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.CfnSpace.KernelGatewayAppSettingsProperty(
        custom_images=[sagemaker.CfnSpace.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",

            # the properties below are optional
            image_version_number=123
        )],
        default_resource_spec=sagemaker.CfnSpace.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    space_storage_settings=sagemaker.CfnSpace.SpaceStorageSettingsProperty(
        ebs_storage_settings=sagemaker.CfnSpace.EbsStorageSettingsProperty(
            ebs_volume_size_in_gb=123
        )
    )
)

Attributes

app_type

The type of app created within the space.

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 Domain.

Permitted users can access this file system in Amazon SageMaker 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

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 CfnSpace.SpaceSharingSettingsProperty(*, sharing_type)

Bases: object

A collection of space sharing settings.

Parameters:

sharing_type (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 import aws_sagemaker as sagemaker

space_sharing_settings_property = sagemaker.CfnSpace.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 CfnSpace.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 import aws_sagemaker as sagemaker

space_storage_settings_property = sagemaker.CfnSpace.SpaceStorageSettingsProperty(
    ebs_storage_settings=sagemaker.CfnSpace.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