CfnSpaceProps

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

Bases: object

Properties for defining a CfnSpace.

Parameters:
  • 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 .

See:

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

cfn_space_props = sagemaker.CfnSpaceProps(
    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"
    )]
)

Attributes

domain_id

The ID of the associated domain.

See:

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

ownership_settings

The collection of ownership settings for a space.

See:

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

space_display_name

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

See:

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

space_name

The name of the space.

See:

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

space_settings

A collection of space settings.

See:

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

space_sharing_settings

A collection of space sharing settings.

See:

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

tags

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

For more information, see Tag .

See:

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