CfnDomainPropsMixin

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

Bases: Mixin

Creates a Domain .

A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker AI uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption .

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.

  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

When internet access is disabled, you won’t be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections. .. epigraph:

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.

For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC .

See:

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

CloudformationResource:

AWS::SageMaker::Domain

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_domain_props_mixin = sagemaker_mixins.CfnDomainPropsMixin(sagemaker_mixins.CfnDomainMixinProps(
    app_network_access_type="appNetworkAccessType",
    app_security_group_management="appSecurityGroupManagement",
    auth_mode="authMode",
    default_space_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceSettingsProperty(
        custom_file_system_configs=[sagemaker_mixins.CfnDomainPropsMixin.CustomFileSystemConfigProperty(
            efs_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
                file_system_id="fileSystemId",
                file_system_path="fileSystemPath"
            ),
            f_sx_lustre_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
                file_system_id="fileSystemId",
                file_system_path="fileSystemPath"
            ),
            s3_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
                mount_path="mountPath",
                s3_uri="s3Uri"
            )
        )],
        custom_posix_user_config=sagemaker_mixins.CfnDomainPropsMixin.CustomPosixUserConfigProperty(
            gid=123,
            uid=123
        ),
        execution_role="executionRole",
        jupyter_lab_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
                idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
            code_repositories=[sagemaker_mixins.CfnDomainPropsMixin.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        jupyter_server_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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.CfnDomainPropsMixin.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        security_groups=["securityGroups"],
        space_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(
            default_ebs_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
                default_ebs_volume_size_in_gb=123,
                maximum_ebs_volume_size_in_gb=123
            )
        )
    ),
    default_user_settings=sagemaker_mixins.CfnDomainPropsMixin.UserSettingsProperty(
        auto_mount_home_efs="autoMountHomeEfs",
        code_editor_app_settings=sagemaker_mixins.CfnDomainPropsMixin.CodeEditorAppSettingsProperty(
            app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
                idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        custom_file_system_configs=[sagemaker_mixins.CfnDomainPropsMixin.CustomFileSystemConfigProperty(
            efs_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
                file_system_id="fileSystemId",
                file_system_path="fileSystemPath"
            ),
            f_sx_lustre_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
                file_system_id="fileSystemId",
                file_system_path="fileSystemPath"
            ),
            s3_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
                mount_path="mountPath",
                s3_uri="s3Uri"
            )
        )],
        custom_posix_user_config=sagemaker_mixins.CfnDomainPropsMixin.CustomPosixUserConfigProperty(
            gid=123,
            uid=123
        ),
        default_landing_uri="defaultLandingUri",
        execution_role="executionRole",
        jupyter_lab_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
                idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
            code_repositories=[sagemaker_mixins.CfnDomainPropsMixin.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        jupyter_server_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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.CfnDomainPropsMixin.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            lifecycle_config_arns=["lifecycleConfigArns"]
        ),
        r_session_app_settings=sagemaker_mixins.CfnDomainPropsMixin.RSessionAppSettingsProperty(
            custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",
                image_version_number=123
            )],
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            )
        ),
        r_studio_server_pro_app_settings=sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProAppSettingsProperty(
            access_status="accessStatus",
            user_group="userGroup"
        ),
        security_groups=["securityGroups"],
        sharing_settings=sagemaker_mixins.CfnDomainPropsMixin.SharingSettingsProperty(
            notebook_output_option="notebookOutputOption",
            s3_kms_key_id="s3KmsKeyId",
            s3_output_path="s3OutputPath"
        ),
        space_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(
            default_ebs_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
                default_ebs_volume_size_in_gb=123,
                maximum_ebs_volume_size_in_gb=123
            )
        ),
        studio_web_portal="studioWebPortal",
        studio_web_portal_settings=sagemaker_mixins.CfnDomainPropsMixin.StudioWebPortalSettingsProperty(
            hidden_app_types=["hiddenAppTypes"],
            hidden_instance_types=["hiddenInstanceTypes"],
            hidden_ml_tools=["hiddenMlTools"],
            hidden_sage_maker_image_version_aliases=[sagemaker_mixins.CfnDomainPropsMixin.HiddenSageMakerImageProperty(
                sage_maker_image_name="sageMakerImageName",
                version_aliases=["versionAliases"]
            )]
        )
    ),
    domain_name="domainName",
    domain_settings=sagemaker_mixins.CfnDomainPropsMixin.DomainSettingsProperty(
        docker_settings=sagemaker_mixins.CfnDomainPropsMixin.DockerSettingsProperty(
            enable_docker_access="enableDockerAccess",
            vpc_only_trusted_accounts=["vpcOnlyTrustedAccounts"]
        ),
        execution_role_identity_config="executionRoleIdentityConfig",
        ip_address_type="ipAddressType",
        r_studio_server_pro_domain_settings=sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProDomainSettingsProperty(
            default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            domain_execution_role_arn="domainExecutionRoleArn",
            r_studio_connect_url="rStudioConnectUrl",
            r_studio_package_manager_url="rStudioPackageManagerUrl"
        ),
        security_group_ids=["securityGroupIds"],
        unified_studio_settings=sagemaker_mixins.CfnDomainPropsMixin.UnifiedStudioSettingsProperty(
            domain_account_id="domainAccountId",
            domain_id="domainId",
            domain_region="domainRegion",
            environment_id="environmentId",
            project_id="projectId",
            project_s3_path="projectS3Path",
            studio_web_portal_access="studioWebPortalAccess"
        )
    ),
    kms_key_id="kmsKeyId",
    subnet_ids=["subnetIds"],
    tag_propagation="tagPropagation",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_id="vpcId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnDomainMixinProps, 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 = ['appNetworkAccessType', 'appSecurityGroupManagement', 'authMode', 'defaultSpaceSettings', 'defaultUserSettings', 'domainName', 'domainSettings', 'kmsKeyId', 'subnetIds', 'tagPropagation', 'tags', 'vpcId']

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

AppLifecycleManagementProperty

class CfnDomainPropsMixin.AppLifecycleManagementProperty(*, idle_settings=None)

Bases: object

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

Parameters:

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

See:

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

app_lifecycle_management_property = sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
    idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
        idle_timeout_in_minutes=123,
        lifecycle_management="lifecycleManagement",
        max_idle_timeout_in_minutes=123,
        min_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-domain-applifecyclemanagement.html#cfn-sagemaker-domain-applifecyclemanagement-idlesettings

CodeEditorAppSettingsProperty

class CfnDomainPropsMixin.CodeEditorAppSettingsProperty(*, app_lifecycle_management=None, built_in_lifecycle_config_arn=None, custom_images=None, default_resource_spec=None, lifecycle_config_arns=None)

Bases: object

The Code Editor application settings.

For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker .

Parameters:

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

  • built_in_lifecycle_config_arn (Optional[str]) – The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

  • 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 Code Editor 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 Code Editor app.

  • lifecycle_config_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.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_editor_app_settings_property = sagemaker_mixins.CfnDomainPropsMixin.CodeEditorAppSettingsProperty(
    app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
        idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
            idle_timeout_in_minutes=123,
            lifecycle_management="lifecycleManagement",
            max_idle_timeout_in_minutes=123,
            min_idle_timeout_in_minutes=123
        )
    ),
    built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
    custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",
        image_version_number=123
    )],
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    lifecycle_config_arns=["lifecycleConfigArns"]
)

Attributes

app_lifecycle_management

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

See:

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

built_in_lifecycle_config_arn

The lifecycle configuration that runs before the default lifecycle configuration.

It can override changes made in the default lifecycle configuration.

See:

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

custom_images

A list of custom SageMaker images that are configured to run as a Code Editor app.

See:

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

default_resource_spec

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

See:

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

lifecycle_config_arns

The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.

See:

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

CodeRepositoryProperty

class CfnDomainPropsMixin.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-domain-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.CfnDomainPropsMixin.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-domain-coderepository.html#cfn-sagemaker-domain-coderepository-repositoryurl

CustomFileSystemConfigProperty

class CfnDomainPropsMixin.CustomFileSystemConfigProperty(*, efs_file_system_config=None, f_sx_lustre_file_system_config=None, s3_file_system_config=None)

Bases: object

The settings for assigning a custom file system 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-domain-customfilesystemconfig.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_config_property = sagemaker_mixins.CfnDomainPropsMixin.CustomFileSystemConfigProperty(
    efs_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
        file_system_id="fileSystemId",
        file_system_path="fileSystemPath"
    ),
    f_sx_lustre_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
        file_system_id="fileSystemId",
        file_system_path="fileSystemPath"
    ),
    s3_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
        mount_path="mountPath",
        s3_uri="s3Uri"
    )
)

Attributes

efs_file_system_config

The settings for a custom Amazon EFS file system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-efsfilesystemconfig

f_sx_lustre_file_system_config

The settings for a custom Amazon FSx for Lustre file system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-fsxlustrefilesystemconfig

s3_file_system_config

Configuration settings for a custom Amazon S3 file system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customfilesystemconfig.html#cfn-sagemaker-domain-customfilesystemconfig-s3filesystemconfig

CustomImageProperty

class CfnDomainPropsMixin.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-domain-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.CfnDomainPropsMixin.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-domain-customimage.html#cfn-sagemaker-domain-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-domain-customimage.html#cfn-sagemaker-domain-customimage-imagename

image_version_number

The version number of the CustomImage.

See:

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

CustomPosixUserConfigProperty

class CfnDomainPropsMixin.CustomPosixUserConfigProperty(*, gid=None, uid=None)

Bases: object

Details about the POSIX identity that is used for file system operations.

Parameters:

  • gid (Union[int, float, None]) – The POSIX group ID.

  • uid (Union[int, float, None]) – The POSIX user ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.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_posix_user_config_property = sagemaker_mixins.CfnDomainPropsMixin.CustomPosixUserConfigProperty(
    gid=123,
    uid=123
)

Attributes

gid

The POSIX group ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-gid

uid

The POSIX user ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customposixuserconfig.html#cfn-sagemaker-domain-customposixuserconfig-uid

DefaultEbsStorageSettingsProperty

class CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(*, default_ebs_volume_size_in_gb=None, maximum_ebs_volume_size_in_gb=None)

Bases: object

A collection of default EBS storage settings that apply to spaces created within a domain or user profile.

Parameters:

  • default_ebs_volume_size_in_gb (Union[int, float, None]) – The default size of the EBS storage volume for a space.

  • maximum_ebs_volume_size_in_gb (Union[int, float, None]) – The maximum size of the EBS storage volume for a space.

See:

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

default_ebs_storage_settings_property = sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
    default_ebs_volume_size_in_gb=123,
    maximum_ebs_volume_size_in_gb=123
)

Attributes

default_ebs_volume_size_in_gb

The default size of the EBS storage volume for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-defaultebsvolumesizeingb

maximum_ebs_volume_size_in_gb

The maximum size of the EBS storage volume for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultebsstoragesettings.html#cfn-sagemaker-domain-defaultebsstoragesettings-maximumebsvolumesizeingb

DefaultSpaceSettingsProperty

class CfnDomainPropsMixin.DefaultSpaceSettingsProperty(*, custom_file_system_configs=None, custom_posix_user_config=None, execution_role=None, jupyter_lab_app_settings=None, jupyter_server_app_settings=None, kernel_gateway_app_settings=None, security_groups=None, space_storage_settings=None)

Bases: object

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn’t apply them to private spaces.

Parameters:
See:

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

default_space_settings_property = sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceSettingsProperty(
    custom_file_system_configs=[sagemaker_mixins.CfnDomainPropsMixin.CustomFileSystemConfigProperty(
        efs_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
            file_system_id="fileSystemId",
            file_system_path="fileSystemPath"
        ),
        f_sx_lustre_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
            file_system_id="fileSystemId",
            file_system_path="fileSystemPath"
        ),
        s3_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
            mount_path="mountPath",
            s3_uri="s3Uri"
        )
    )],
    custom_posix_user_config=sagemaker_mixins.CfnDomainPropsMixin.CustomPosixUserConfigProperty(
        gid=123,
        uid=123
    ),
    execution_role="executionRole",
    jupyter_lab_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterLabAppSettingsProperty(
        app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
            idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                idle_timeout_in_minutes=123,
                lifecycle_management="lifecycleManagement",
                max_idle_timeout_in_minutes=123,
                min_idle_timeout_in_minutes=123
            )
        ),
        built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
        code_repositories=[sagemaker_mixins.CfnDomainPropsMixin.CodeRepositoryProperty(
            repository_url="repositoryUrl"
        )],
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    jupyter_server_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterServerAppSettingsProperty(
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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.CfnDomainPropsMixin.KernelGatewayAppSettingsProperty(
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    security_groups=["securityGroups"],
    space_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(
        default_ebs_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
            default_ebs_volume_size_in_gb=123,
            maximum_ebs_volume_size_in_gb=123
        )
    )
)

Attributes

custom_file_system_configs

The settings for assigning a custom file system to a 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-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customfilesystemconfigs

custom_posix_user_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-customposixuserconfig

Type:

see

execution_role

The ARN of the execution role for the space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-executionrole

jupyter_lab_app_settings

The JupyterLab app settings.

See:

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

jupyter_server_app_settings

The JupyterServer app settings.

See:

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

kernel_gateway_app_settings

The KernelGateway app settings.

See:

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

security_groups

The security group IDs for the Amazon VPC that the space uses for communication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html#cfn-sagemaker-domain-defaultspacesettings-securitygroups

space_storage_settings

Default storage settings for a space.

See:

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

DefaultSpaceStorageSettingsProperty

class CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(*, default_ebs_storage_settings=None)

Bases: object

The default storage settings for a space.

Parameters:

default_ebs_storage_settings (Union[IResolvable, DefaultEbsStorageSettingsProperty, Dict[str, Any], None]) – The default EBS storage settings for a space.

See:

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

default_space_storage_settings_property = sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(
    default_ebs_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
        default_ebs_volume_size_in_gb=123,
        maximum_ebs_volume_size_in_gb=123
    )
)

Attributes

default_ebs_storage_settings

The default EBS storage settings for a space.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacestoragesettings.html#cfn-sagemaker-domain-defaultspacestoragesettings-defaultebsstoragesettings

DockerSettingsProperty

class CfnDomainPropsMixin.DockerSettingsProperty(*, enable_docker_access=None, vpc_only_trusted_accounts=None)

Bases: object

A collection of settings that configure the domain’s Docker interaction.

Parameters:

  • enable_docker_access (Optional[str]) – Indicates whether the domain can access Docker.

  • vpc_only_trusted_accounts (Optional[Sequence[str]]) – The list of AWS accounts that are trusted when the domain is created in VPC-only mode.

See:

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

docker_settings_property = sagemaker_mixins.CfnDomainPropsMixin.DockerSettingsProperty(
    enable_docker_access="enableDockerAccess",
    vpc_only_trusted_accounts=["vpcOnlyTrustedAccounts"]
)

Attributes

enable_docker_access

Indicates whether the domain can access Docker.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-enabledockeraccess

vpc_only_trusted_accounts

The list of AWS accounts that are trusted when the domain is created in VPC-only mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-dockersettings.html#cfn-sagemaker-domain-dockersettings-vpconlytrustedaccounts

DomainSettingsProperty

class CfnDomainPropsMixin.DomainSettingsProperty(*, docker_settings=None, execution_role_identity_config=None, ip_address_type=None, r_studio_server_pro_domain_settings=None, security_group_ids=None, unified_studio_settings=None)

Bases: object

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Parameters:

  • docker_settings (Union[IResolvable, DockerSettingsProperty, Dict[str, Any], None]) – A collection of settings that configure the domain’s Docker interaction.

  • execution_role_identity_config (Optional[str]) – The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .

  • ip_address_type (Optional[str]) – The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack , the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4 .

  • r_studio_server_pro_domain_settings (Union[IResolvable, RStudioServerProDomainSettingsProperty, Dict[str, Any], None]) – A collection of settings that configure the RStudioServerPro Domain-level app.

  • security_group_ids (Optional[Sequence[str]]) – The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

  • unified_studio_settings (Union[IResolvable, UnifiedStudioSettingsProperty, Dict[str, Any], None]) – The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

See:

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

domain_settings_property = sagemaker_mixins.CfnDomainPropsMixin.DomainSettingsProperty(
    docker_settings=sagemaker_mixins.CfnDomainPropsMixin.DockerSettingsProperty(
        enable_docker_access="enableDockerAccess",
        vpc_only_trusted_accounts=["vpcOnlyTrustedAccounts"]
    ),
    execution_role_identity_config="executionRoleIdentityConfig",
    ip_address_type="ipAddressType",
    r_studio_server_pro_domain_settings=sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProDomainSettingsProperty(
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        domain_execution_role_arn="domainExecutionRoleArn",
        r_studio_connect_url="rStudioConnectUrl",
        r_studio_package_manager_url="rStudioPackageManagerUrl"
    ),
    security_group_ids=["securityGroupIds"],
    unified_studio_settings=sagemaker_mixins.CfnDomainPropsMixin.UnifiedStudioSettingsProperty(
        domain_account_id="domainAccountId",
        domain_id="domainId",
        domain_region="domainRegion",
        environment_id="environmentId",
        project_id="projectId",
        project_s3_path="projectS3Path",
        studio_web_portal_access="studioWebPortalAccess"
    )
)

Attributes

docker_settings

A collection of settings that configure the domain’s Docker interaction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-dockersettings

execution_role_identity_config

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-executionroleidentityconfig

ip_address_type

The IP address type for the domain.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-ipaddresstype

r_studio_server_pro_domain_settings

A collection of settings that configure the RStudioServerPro Domain-level app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-rstudioserverprodomainsettings

security_group_ids

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-securitygroupids

unified_studio_settings

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-unifiedstudiosettings

EFSFileSystemConfigProperty

class CfnDomainPropsMixin.EFSFileSystemConfigProperty(*, file_system_id=None, file_system_path=None)

Bases: object

The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.

Parameters:

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

  • file_system_path (Optional[str]) – The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.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_config_property = sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
    file_system_id="fileSystemId",
    file_system_path="fileSystemPath"
)

Attributes

file_system_id

The ID of your Amazon EFS file system.

See:

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

file_system_path

The path to the file system directory that is accessible in Amazon SageMaker AI Studio.

Permitted users can access only this directory and below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-efsfilesystemconfig.html#cfn-sagemaker-domain-efsfilesystemconfig-filesystempath

FSxLustreFileSystemConfigProperty

class CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(*, file_system_id=None, file_system_path=None)

Bases: object

The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.

Parameters:

  • file_system_id (Optional[str]) – The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.

  • file_system_path (Optional[str]) – The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.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_config_property = sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
    file_system_id="fileSystemId",
    file_system_path="fileSystemPath"
)

Attributes

file_system_id

The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.

See:

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

file_system_path

The path to the file system directory that is accessible in Amazon SageMaker Studio.

Permitted users can access only this directory and below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-fsxlustrefilesystemconfig.html#cfn-sagemaker-domain-fsxlustrefilesystemconfig-filesystempath

HiddenSageMakerImageProperty

class CfnDomainPropsMixin.HiddenSageMakerImageProperty(*, sage_maker_image_name=None, version_aliases=None)

Bases: object

The SageMaker images that are hidden from the Studio user interface.

You must specify the SageMaker image name and version aliases.

Parameters:

  • sage_maker_image_name (Optional[str]) – The SageMaker image name that you are hiding from the Studio user interface.

  • version_aliases (Optional[Sequence[str]]) – The version aliases you are hiding from the Studio user interface.

See:

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

hidden_sage_maker_image_property = sagemaker_mixins.CfnDomainPropsMixin.HiddenSageMakerImageProperty(
    sage_maker_image_name="sageMakerImageName",
    version_aliases=["versionAliases"]
)

Attributes

sage_maker_image_name

The SageMaker image name that you are hiding from the Studio user interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-hiddensagemakerimage.html#cfn-sagemaker-domain-hiddensagemakerimage-sagemakerimagename

version_aliases

The version aliases you are hiding from the Studio user interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-hiddensagemakerimage.html#cfn-sagemaker-domain-hiddensagemakerimage-versionaliases

IdleSettingsProperty

class CfnDomainPropsMixin.IdleSettingsProperty(*, idle_timeout_in_minutes=None, lifecycle_management=None, max_idle_timeout_in_minutes=None, min_idle_timeout_in_minutes=None)

Bases: object

Settings related to idle shutdown of Studio applications.

Parameters:

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

  • lifecycle_management (Optional[str]) – Indicates whether idle shutdown is activated for the application type.

  • max_idle_timeout_in_minutes (Union[int, float, None]) – The maximum value in minutes that custom idle shutdown can be set to by the user.

  • min_idle_timeout_in_minutes (Union[int, float, None]) – The minimum value in minutes that custom idle shutdown can be set to by the user.

See:

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

idle_settings_property = sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
    idle_timeout_in_minutes=123,
    lifecycle_management="lifecycleManagement",
    max_idle_timeout_in_minutes=123,
    min_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-domain-idlesettings.html#cfn-sagemaker-domain-idlesettings-idletimeoutinminutes

lifecycle_management

Indicates whether idle shutdown is activated for the application type.

See:

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

max_idle_timeout_in_minutes

The maximum value in minutes that custom idle shutdown can be set to by the user.

See:

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

min_idle_timeout_in_minutes

The minimum value in minutes that custom idle shutdown can be set to by the user.

See:

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

JupyterLabAppSettingsProperty

class CfnDomainPropsMixin.JupyterLabAppSettingsProperty(*, app_lifecycle_management=None, built_in_lifecycle_config_arn=None, code_repositories=None, custom_images=None, default_resource_spec=None, lifecycle_config_arns=None)

Bases: object

The settings for the JupyterLab application.

Parameters:

  • app_lifecycle_management (Union[IResolvable, AppLifecycleManagementProperty, Dict[str, Any], None]) – Indicates whether idle shutdown is activated for JupyterLab applications.

  • built_in_lifecycle_config_arn (Optional[str]) – The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.

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

  • 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 JupyterLab 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 JupyterLab app.

  • lifecycle_config_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the lifecycle configurations attached to 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-domain-jupyterlabappsettings.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_lab_app_settings_property = sagemaker_mixins.CfnDomainPropsMixin.JupyterLabAppSettingsProperty(
    app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
        idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
            idle_timeout_in_minutes=123,
            lifecycle_management="lifecycleManagement",
            max_idle_timeout_in_minutes=123,
            min_idle_timeout_in_minutes=123
        )
    ),
    built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
    code_repositories=[sagemaker_mixins.CfnDomainPropsMixin.CodeRepositoryProperty(
        repository_url="repositoryUrl"
    )],
    custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",
        image_version_number=123
    )],
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    lifecycle_config_arns=["lifecycleConfigArns"]
)

Attributes

app_lifecycle_management

Indicates whether idle shutdown is activated for JupyterLab applications.

See:

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

built_in_lifecycle_config_arn

The lifecycle configuration that runs before the default lifecycle configuration.

It can override changes made in the default lifecycle configuration.

See:

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

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-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-coderepositories

custom_images

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

See:

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

default_resource_spec

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

See:

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

lifecycle_config_arns

The Amazon Resource Name (ARN) of the lifecycle configurations attached to 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-domain-jupyterlabappsettings.html#cfn-sagemaker-domain-jupyterlabappsettings-lifecycleconfigarns

JupyterServerAppSettingsProperty

class CfnDomainPropsMixin.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.

  • 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-domain-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.CfnDomainPropsMixin.JupyterServerAppSettingsProperty(
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-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-domain-jupyterserverappsettings.html#cfn-sagemaker-domain-jupyterserverappsettings-lifecycleconfigarns

KernelGatewayAppSettingsProperty

class CfnDomainPropsMixin.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-domain-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.CfnDomainPropsMixin.KernelGatewayAppSettingsProperty(
    custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",
        image_version_number=123
    )],
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-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-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-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-domain-kernelgatewayappsettings.html#cfn-sagemaker-domain-kernelgatewayappsettings-lifecycleconfigarns

RSessionAppSettingsProperty

class CfnDomainPropsMixin.RSessionAppSettingsProperty(*, custom_images=None, default_resource_spec=None)

Bases: object

A collection of settings that apply to an RSessionGateway app.

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 RSession app.

  • 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-domain-rsessionappsettings.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

r_session_app_settings_property = sagemaker_mixins.CfnDomainPropsMixin.RSessionAppSettingsProperty(
    custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
        app_image_config_name="appImageConfigName",
        image_name="imageName",
        image_version_number=123
    )],
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    )
)

Attributes

custom_images

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

See:

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

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-domain-rsessionappsettings.html#cfn-sagemaker-domain-rsessionappsettings-defaultresourcespec

RStudioServerProAppSettingsProperty

class CfnDomainPropsMixin.RStudioServerProAppSettingsProperty(*, access_status=None, user_group=None)

Bases: object

A collection of settings that configure user interaction with the RStudioServerPro app.

Parameters:

  • access_status (Optional[str]) – Indicates whether the current user has access to the RStudioServerPro app.

  • user_group (Optional[str]) – The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

See:

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

r_studio_server_pro_app_settings_property = sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProAppSettingsProperty(
    access_status="accessStatus",
    user_group="userGroup"
)

Attributes

access_status

Indicates whether the current user has access to the RStudioServerPro app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-accessstatus

user_group

The level of permissions that the user has within the RStudioServerPro app.

This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html#cfn-sagemaker-domain-rstudioserverproappsettings-usergroup

RStudioServerProDomainSettingsProperty

class CfnDomainPropsMixin.RStudioServerProDomainSettingsProperty(*, default_resource_spec=None, domain_execution_role_arn=None, r_studio_connect_url=None, r_studio_package_manager_url=None)

Bases: object

A collection of settings that configure the RStudioServerPro Domain-level app.

Parameters:

  • default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.

  • domain_execution_role_arn (Optional[str]) – The ARN of the execution role for the RStudioServerPro Domain-level app.

  • r_studio_connect_url (Optional[str]) – A URL pointing to an RStudio Connect server.

  • r_studio_package_manager_url (Optional[str]) – A URL pointing to an RStudio Package Manager server.

See:

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

r_studio_server_pro_domain_settings_property = sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProDomainSettingsProperty(
    default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
        instance_type="instanceType",
        lifecycle_config_arn="lifecycleConfigArn",
        sage_maker_image_arn="sageMakerImageArn",
        sage_maker_image_version_arn="sageMakerImageVersionArn"
    ),
    domain_execution_role_arn="domainExecutionRoleArn",
    r_studio_connect_url="rStudioConnectUrl",
    r_studio_package_manager_url="rStudioPackageManagerUrl"
)

Attributes

default_resource_spec

A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.

See:

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

domain_execution_role_arn

The ARN of the execution role for the RStudioServerPro Domain-level app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-domainexecutionrolearn

r_studio_connect_url

A URL pointing to an RStudio Connect server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudioconnecturl

r_studio_package_manager_url

A URL pointing to an RStudio Package Manager server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html#cfn-sagemaker-domain-rstudioserverprodomainsettings-rstudiopackagemanagerurl

ResourceSpecProperty

class CfnDomainPropsMixin.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-domain-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.CfnDomainPropsMixin.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-domain-resourcespec.html#cfn-sagemaker-domain-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-domain-resourcespec.html#cfn-sagemaker-domain-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-domain-resourcespec.html#cfn-sagemaker-domain-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-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-sagemakerimageversionarn

S3FileSystemConfigProperty

class CfnDomainPropsMixin.S3FileSystemConfigProperty(*, mount_path=None, s3_uri=None)

Bases: object

Configuration for the custom Amazon S3 file system.

Parameters:

  • mount_path (Optional[str]) – The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.

  • s3_uri (Optional[str]) – The Amazon S3 URI of the S3 file system configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.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_config_property = sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
    mount_path="mountPath",
    s3_uri="s3Uri"
)

Attributes

mount_path

The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-s3filesystemconfig.html#cfn-sagemaker-domain-s3filesystemconfig-mountpath

s3_uri

The Amazon S3 URI of the S3 file system configuration.

See:

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

SharingSettingsProperty

class CfnDomainPropsMixin.SharingSettingsProperty(*, notebook_output_option=None, s3_kms_key_id=None, s3_output_path=None)

Bases: object

Specifies options when sharing an Amazon SageMaker Studio notebook.

These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called.

Parameters:

  • notebook_output_option (Optional[str]) – Whether to include the notebook cell output when sharing the notebook. The default is Disabled .

  • s3_kms_key_id (Optional[str]) – When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

  • s3_output_path (Optional[str]) – When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

See:

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

sharing_settings_property = sagemaker_mixins.CfnDomainPropsMixin.SharingSettingsProperty(
    notebook_output_option="notebookOutputOption",
    s3_kms_key_id="s3KmsKeyId",
    s3_output_path="s3OutputPath"
)

Attributes

notebook_output_option

Whether to include the notebook cell output when sharing the notebook.

The default is Disabled .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-notebookoutputoption

s3_kms_key_id

When NotebookOutputOption is Allowed , the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3kmskeyid

s3_output_path

When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html#cfn-sagemaker-domain-sharingsettings-s3outputpath

StudioWebPortalSettingsProperty

class CfnDomainPropsMixin.StudioWebPortalSettingsProperty(*, hidden_app_types=None, hidden_instance_types=None, hidden_ml_tools=None, hidden_sage_maker_image_version_aliases=None)

Bases: object

Studio settings.

If these settings are applied on a user level, they take priority over the settings applied on a domain level.

Parameters:

  • hidden_app_types (Optional[Sequence[str]]) – The Applications supported in Studio that are hidden from the Studio left navigation pane.

  • hidden_instance_types (Optional[Sequence[str]]) – The instance types you are hiding from the Studio user interface.

  • hidden_ml_tools (Optional[Sequence[str]]) – The machine learning tools that are hidden from the Studio left navigation pane.

  • hidden_sage_maker_image_version_aliases (Union[IResolvable, Sequence[Union[IResolvable, HiddenSageMakerImageProperty, Dict[str, Any]]], None]) – The version aliases you are hiding from the Studio user interface.

See:

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

studio_web_portal_settings_property = sagemaker_mixins.CfnDomainPropsMixin.StudioWebPortalSettingsProperty(
    hidden_app_types=["hiddenAppTypes"],
    hidden_instance_types=["hiddenInstanceTypes"],
    hidden_ml_tools=["hiddenMlTools"],
    hidden_sage_maker_image_version_aliases=[sagemaker_mixins.CfnDomainPropsMixin.HiddenSageMakerImageProperty(
        sage_maker_image_name="sageMakerImageName",
        version_aliases=["versionAliases"]
    )]
)

Attributes

hidden_app_types

The Applications supported in Studio that are hidden from the Studio left navigation pane.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenapptypes

hidden_instance_types

The instance types you are hiding from the Studio user interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddeninstancetypes

hidden_ml_tools

The machine learning tools that are hidden from the Studio left navigation pane.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddenmltools

hidden_sage_maker_image_version_aliases

The version aliases you are hiding from the Studio user interface.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html#cfn-sagemaker-domain-studiowebportalsettings-hiddensagemakerimageversionaliases

UnifiedStudioSettingsProperty

class CfnDomainPropsMixin.UnifiedStudioSettingsProperty(*, domain_account_id=None, domain_id=None, domain_region=None, environment_id=None, project_id=None, project_s3_path=None, studio_web_portal_access=None)

Bases: object

The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Parameters:

  • domain_account_id (Optional[str]) – The ID of the AWS account that has the Amazon SageMaker Unified Studio domain. The default value, if you don’t specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

  • domain_id (Optional[str]) – The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

  • domain_region (Optional[str]) – The AWS Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don’t specify a Region, is the Region where the Amazon SageMaker AI domain is located.

  • environment_id (Optional[str]) – The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

  • project_id (Optional[str]) – The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

  • project_s3_path (Optional[str]) – The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

  • studio_web_portal_access (Optional[str]) – Sets whether you can access the domain in Amazon SageMaker Studio:. - ENABLED - You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces. - DISABLED - You can’t access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface. To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

See:

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

unified_studio_settings_property = sagemaker_mixins.CfnDomainPropsMixin.UnifiedStudioSettingsProperty(
    domain_account_id="domainAccountId",
    domain_id="domainId",
    domain_region="domainRegion",
    environment_id="environmentId",
    project_id="projectId",
    project_s3_path="projectS3Path",
    studio_web_portal_access="studioWebPortalAccess"
)

Attributes

domain_account_id

The ID of the AWS account that has the Amazon SageMaker Unified Studio domain.

The default value, if you don’t specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainaccountid

domain_id

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainid

domain_region

The AWS Region where the domain is located in Amazon SageMaker Unified Studio.

The default value, if you don’t specify a Region, is the Region where the Amazon SageMaker AI domain is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainregion

environment_id

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-environmentid

project_id

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projectid

project_s3_path

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projects3path

studio_web_portal_access

.

  • ENABLED - You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

  • DISABLED - You can’t access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-studiowebportalaccess

Type:

Sets whether you can access the domain in Amazon SageMaker Studio

UserSettingsProperty

class CfnDomainPropsMixin.UserSettingsProperty(*, auto_mount_home_efs=None, code_editor_app_settings=None, custom_file_system_configs=None, custom_posix_user_config=None, default_landing_uri=None, execution_role=None, jupyter_lab_app_settings=None, jupyter_server_app_settings=None, kernel_gateway_app_settings=None, r_session_app_settings=None, r_studio_server_pro_app_settings=None, security_groups=None, sharing_settings=None, space_storage_settings=None, studio_web_portal=None, studio_web_portal_settings=None)

Bases: object

A collection of settings that apply to users of Amazon SageMaker Studio.

These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings , the values specified in CreateUserProfile take precedence over those specified in CreateDomain .

Parameters:

  • auto_mount_home_efs (Optional[str]) – Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain. SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.

  • code_editor_app_settings (Union[IResolvable, CodeEditorAppSettingsProperty, Dict[str, Any], None]) – The Code Editor application settings. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • custom_file_system_configs (Union[IResolvable, Sequence[Union[IResolvable, CustomFileSystemConfigProperty, Dict[str, Any]]], None]) – The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • custom_posix_user_config (Union[IResolvable, CustomPosixUserConfigProperty, Dict[str, Any], None]) – Details about the POSIX identity that is used for file system operations. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • default_landing_uri (Optional[str]) – The default experience that the user is directed to when accessing the domain. The supported values are:. - studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED . - app:JupyterServer: : Indicates that Studio Classic is the default experience.

  • execution_role (Optional[str]) – The execution role for the user. SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.

  • jupyter_lab_app_settings (Union[IResolvable, JupyterLabAppSettingsProperty, Dict[str, Any], None]) – The settings for the JupyterLab application. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • jupyter_server_app_settings (Union[IResolvable, JupyterServerAppSettingsProperty, Dict[str, Any], None]) – The Jupyter server’s app settings.

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

  • r_session_app_settings (Union[IResolvable, RSessionAppSettingsProperty, Dict[str, Any], None]) – A collection of settings that configure the RSessionGateway app.

  • r_studio_server_pro_app_settings (Union[IResolvable, RStudioServerProAppSettingsProperty, Dict[str, Any], None]) – A collection of settings that configure user interaction with the RStudioServerPro app.

  • security_groups (Optional[Sequence[str]]) – The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly . Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain. Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • sharing_settings (Union[IResolvable, SharingSettingsProperty, Dict[str, Any], None]) – Specifies options for sharing Amazon SageMaker AI Studio notebooks.

  • space_storage_settings (Union[IResolvable, DefaultSpaceStorageSettingsProperty, Dict[str, Any], None]) – The storage settings for a space. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

  • studio_web_portal (Optional[str]) – Whether the user can access Studio. If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

  • studio_web_portal_settings (Union[IResolvable, StudioWebPortalSettingsProperty, Dict[str, Any], None]) – Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

See:

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

user_settings_property = sagemaker_mixins.CfnDomainPropsMixin.UserSettingsProperty(
    auto_mount_home_efs="autoMountHomeEfs",
    code_editor_app_settings=sagemaker_mixins.CfnDomainPropsMixin.CodeEditorAppSettingsProperty(
        app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
            idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                idle_timeout_in_minutes=123,
                lifecycle_management="lifecycleManagement",
                max_idle_timeout_in_minutes=123,
                min_idle_timeout_in_minutes=123
            )
        ),
        built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    custom_file_system_configs=[sagemaker_mixins.CfnDomainPropsMixin.CustomFileSystemConfigProperty(
        efs_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.EFSFileSystemConfigProperty(
            file_system_id="fileSystemId",
            file_system_path="fileSystemPath"
        ),
        f_sx_lustre_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.FSxLustreFileSystemConfigProperty(
            file_system_id="fileSystemId",
            file_system_path="fileSystemPath"
        ),
        s3_file_system_config=sagemaker_mixins.CfnDomainPropsMixin.S3FileSystemConfigProperty(
            mount_path="mountPath",
            s3_uri="s3Uri"
        )
    )],
    custom_posix_user_config=sagemaker_mixins.CfnDomainPropsMixin.CustomPosixUserConfigProperty(
        gid=123,
        uid=123
    ),
    default_landing_uri="defaultLandingUri",
    execution_role="executionRole",
    jupyter_lab_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterLabAppSettingsProperty(
        app_lifecycle_management=sagemaker_mixins.CfnDomainPropsMixin.AppLifecycleManagementProperty(
            idle_settings=sagemaker_mixins.CfnDomainPropsMixin.IdleSettingsProperty(
                idle_timeout_in_minutes=123,
                lifecycle_management="lifecycleManagement",
                max_idle_timeout_in_minutes=123,
                min_idle_timeout_in_minutes=123
            )
        ),
        built_in_lifecycle_config_arn="builtInLifecycleConfigArn",
        code_repositories=[sagemaker_mixins.CfnDomainPropsMixin.CodeRepositoryProperty(
            repository_url="repositoryUrl"
        )],
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    jupyter_server_app_settings=sagemaker_mixins.CfnDomainPropsMixin.JupyterServerAppSettingsProperty(
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.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.CfnDomainPropsMixin.KernelGatewayAppSettingsProperty(
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        ),
        lifecycle_config_arns=["lifecycleConfigArns"]
    ),
    r_session_app_settings=sagemaker_mixins.CfnDomainPropsMixin.RSessionAppSettingsProperty(
        custom_images=[sagemaker_mixins.CfnDomainPropsMixin.CustomImageProperty(
            app_image_config_name="appImageConfigName",
            image_name="imageName",
            image_version_number=123
        )],
        default_resource_spec=sagemaker_mixins.CfnDomainPropsMixin.ResourceSpecProperty(
            instance_type="instanceType",
            lifecycle_config_arn="lifecycleConfigArn",
            sage_maker_image_arn="sageMakerImageArn",
            sage_maker_image_version_arn="sageMakerImageVersionArn"
        )
    ),
    r_studio_server_pro_app_settings=sagemaker_mixins.CfnDomainPropsMixin.RStudioServerProAppSettingsProperty(
        access_status="accessStatus",
        user_group="userGroup"
    ),
    security_groups=["securityGroups"],
    sharing_settings=sagemaker_mixins.CfnDomainPropsMixin.SharingSettingsProperty(
        notebook_output_option="notebookOutputOption",
        s3_kms_key_id="s3KmsKeyId",
        s3_output_path="s3OutputPath"
    ),
    space_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultSpaceStorageSettingsProperty(
        default_ebs_storage_settings=sagemaker_mixins.CfnDomainPropsMixin.DefaultEbsStorageSettingsProperty(
            default_ebs_volume_size_in_gb=123,
            maximum_ebs_volume_size_in_gb=123
        )
    ),
    studio_web_portal="studioWebPortal",
    studio_web_portal_settings=sagemaker_mixins.CfnDomainPropsMixin.StudioWebPortalSettingsProperty(
        hidden_app_types=["hiddenAppTypes"],
        hidden_instance_types=["hiddenInstanceTypes"],
        hidden_ml_tools=["hiddenMlTools"],
        hidden_sage_maker_image_version_aliases=[sagemaker_mixins.CfnDomainPropsMixin.HiddenSageMakerImageProperty(
            sage_maker_image_name="sageMakerImageName",
            version_aliases=["versionAliases"]
        )]
    )
)

Attributes

auto_mount_home_efs

Indicates whether auto-mounting of an EFS volume is supported for the user profile.

The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-automounthomeefs

code_editor_app_settings

The Code Editor application settings.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

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

custom_file_system_configs

The settings for assigning a custom file system to a user profile.

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

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customfilesystemconfigs

custom_posix_user_config

Details about the POSIX identity that is used for file system operations.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-customposixuserconfig

default_landing_uri

.

  • studio:: : Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED .

  • app:JupyterServer: : Indicates that Studio Classic is the default experience.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-defaultlandinguri

Type:

The default experience that the user is directed to when accessing the domain. The supported values are

execution_role

The execution role for the user.

SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn’t apply this setting to shared spaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-executionrole

jupyter_lab_app_settings

The settings for the JupyterLab application.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

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

jupyter_server_app_settings

The Jupyter server’s app settings.

See:

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

kernel_gateway_app_settings

The kernel gateway app settings.

See:

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

r_session_app_settings

A collection of settings that configure the RSessionGateway app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rsessionappsettings

r_studio_server_pro_app_settings

A collection of settings that configure user interaction with the RStudioServerPro app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-rstudioserverproappsettings

security_groups

The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.

Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-securitygroups

sharing_settings

Specifies options for sharing Amazon SageMaker AI Studio notebooks.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-sharingsettings

space_storage_settings

The storage settings for a space.

SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn’t apply these settings to shared spaces.

See:

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

studio_web_portal

Whether the user can access Studio.

If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportal

studio_web_portal_settings

Studio settings.

If these settings are applied on a user level, they take priority over the settings applied on a domain level.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html#cfn-sagemaker-domain-usersettings-studiowebportalsettings