CfnDomainProps

class aws_cdk.aws_sagemaker.CfnDomainProps(*, auth_mode, default_user_settings, domain_name, subnet_ids, vpc_id, app_network_access_type=None, app_security_group_management=None, default_space_settings=None, domain_settings=None, kms_key_id=None, tags=None)

Bases: object

Properties for defining a CfnDomain.

Parameters:
  • auth_mode (str) – The mode of authentication that members use to access the Domain. Valid Values : SSO | IAM

  • default_user_settings (Union[IResolvable, UserSettingsProperty, Dict[str, Any]]) – The default user settings.

  • domain_name (str) – The domain name.

  • subnet_ids (Sequence[str]) – The VPC subnets that Studio uses for communication. Length Constraints : Maximum length of 32. Array members : Minimum number of 1 item. Maximum number of 16 items. Pattern : [-0-9a-zA-Z]+

  • vpc_id (str) – The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. Length Constraints : Maximum length of 32. Pattern : [-0-9a-zA-Z]+

  • app_network_access_type (Optional[str]) – Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly . - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access - VpcOnly - All Studio traffic is through the specified VPC and subnets Valid Values : PublicInternetOnly | VpcOnly

  • app_security_group_management (Optional[str]) – The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode. Required when CreateDomain.AppNetworkAccessType is VpcOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service . Allowed Values : Service | Customer

  • default_space_settings (Union[IResolvable, DefaultSpaceSettingsProperty, Dict[str, Any], None]) – A collection of settings that apply to spaces created in the domain.

  • domain_settings (Union[IResolvable, DomainSettingsProperty, Dict[str, Any], None]) – A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.

  • kms_key_id (Optional[str]) – SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK. Length Constraints : Maximum length of 2048. Pattern : .*

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. Tags that you specify for the Domain are also added to all apps that are launched in the Domain. Array members : Minimum number of 0 items. Maximum number of 50 items.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_domain_props = sagemaker.CfnDomainProps(
    auth_mode="authMode",
    default_user_settings=sagemaker.CfnDomain.UserSettingsProperty(
        execution_role="executionRole",

        # the properties below are optional
        code_editor_app_settings=sagemaker.CfnDomain.CodeEditorAppSettingsProperty(
            app_lifecycle_management=sagemaker.CfnDomain.AppLifecycleManagementProperty(
                idle_settings=sagemaker.CfnDomain.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.CustomFileSystemConfigProperty(
            efs_file_system_config=sagemaker.CfnDomain.EFSFileSystemConfigProperty(
                file_system_id="fileSystemId",

                # the properties below are optional
                file_system_path="fileSystemPath"
            )
        )],
        custom_posix_user_config=sagemaker.CfnDomain.CustomPosixUserConfigProperty(
            gid=123,
            uid=123
        ),
        default_landing_uri="defaultLandingUri",
        jupyter_lab_app_settings=sagemaker.CfnDomain.JupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker.CfnDomain.AppLifecycleManagementProperty(
                idle_settings=sagemaker.CfnDomain.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            code_repositories=[sagemaker.CfnDomain.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.RSessionAppSettingsProperty(
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.RStudioServerProAppSettingsProperty(
            access_status="accessStatus",
            user_group="userGroup"
        ),
        security_groups=["securityGroups"],
        sharing_settings=sagemaker.CfnDomain.SharingSettingsProperty(
            notebook_output_option="notebookOutputOption",
            s3_kms_key_id="s3KmsKeyId",
            s3_output_path="s3OutputPath"
        ),
        space_storage_settings=sagemaker.CfnDomain.DefaultSpaceStorageSettingsProperty(
            default_ebs_storage_settings=sagemaker.CfnDomain.DefaultEbsStorageSettingsProperty(
                default_ebs_volume_size_in_gb=123,
                maximum_ebs_volume_size_in_gb=123
            )
        ),
        studio_web_portal="studioWebPortal",
        studio_web_portal_settings=sagemaker.CfnDomain.StudioWebPortalSettingsProperty(
            hidden_app_types=["hiddenAppTypes"],
            hidden_ml_tools=["hiddenMlTools"]
        )
    ),
    domain_name="domainName",
    subnet_ids=["subnetIds"],
    vpc_id="vpcId",

    # the properties below are optional
    app_network_access_type="appNetworkAccessType",
    app_security_group_management="appSecurityGroupManagement",
    default_space_settings=sagemaker.CfnDomain.DefaultSpaceSettingsProperty(
        execution_role="executionRole",

        # the properties below are optional
        custom_file_system_configs=[sagemaker.CfnDomain.CustomFileSystemConfigProperty(
            efs_file_system_config=sagemaker.CfnDomain.EFSFileSystemConfigProperty(
                file_system_id="fileSystemId",

                # the properties below are optional
                file_system_path="fileSystemPath"
            )
        )],
        custom_posix_user_config=sagemaker.CfnDomain.CustomPosixUserConfigProperty(
            gid=123,
            uid=123
        ),
        jupyter_lab_app_settings=sagemaker.CfnDomain.JupyterLabAppSettingsProperty(
            app_lifecycle_management=sagemaker.CfnDomain.AppLifecycleManagementProperty(
                idle_settings=sagemaker.CfnDomain.IdleSettingsProperty(
                    idle_timeout_in_minutes=123,
                    lifecycle_management="lifecycleManagement",
                    max_idle_timeout_in_minutes=123,
                    min_idle_timeout_in_minutes=123
                )
            ),
            code_repositories=[sagemaker.CfnDomain.CodeRepositoryProperty(
                repository_url="repositoryUrl"
            )],
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.JupyterServerAppSettingsProperty(
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.KernelGatewayAppSettingsProperty(
            custom_images=[sagemaker.CfnDomain.CustomImageProperty(
                app_image_config_name="appImageConfigName",
                image_name="imageName",

                # the properties below are optional
                image_version_number=123
            )],
            default_resource_spec=sagemaker.CfnDomain.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.CfnDomain.DefaultSpaceStorageSettingsProperty(
            default_ebs_storage_settings=sagemaker.CfnDomain.DefaultEbsStorageSettingsProperty(
                default_ebs_volume_size_in_gb=123,
                maximum_ebs_volume_size_in_gb=123
            )
        )
    ),
    domain_settings=sagemaker.CfnDomain.DomainSettingsProperty(
        docker_settings=sagemaker.CfnDomain.DockerSettingsProperty(
            enable_docker_access="enableDockerAccess",
            vpc_only_trusted_accounts=["vpcOnlyTrustedAccounts"]
        ),
        r_studio_server_pro_domain_settings=sagemaker.CfnDomain.RStudioServerProDomainSettingsProperty(
            domain_execution_role_arn="domainExecutionRoleArn",

            # the properties below are optional
            default_resource_spec=sagemaker.CfnDomain.ResourceSpecProperty(
                instance_type="instanceType",
                lifecycle_config_arn="lifecycleConfigArn",
                sage_maker_image_arn="sageMakerImageArn",
                sage_maker_image_version_arn="sageMakerImageVersionArn"
            ),
            r_studio_connect_url="rStudioConnectUrl",
            r_studio_package_manager_url="rStudioPackageManagerUrl"
        ),
        security_group_ids=["securityGroupIds"]
    ),
    kms_key_id="kmsKeyId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_network_access_type

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access

  • VpcOnly - All Studio traffic is through the specified VPC and subnets

Valid Values : PublicInternetOnly | VpcOnly

See:

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

app_security_group_management

The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.

Required when CreateDomain.AppNetworkAccessType is VpcOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service .

Allowed Values : Service | Customer

See:

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

auth_mode

The mode of authentication that members use to access the Domain.

Valid Values : SSO | IAM

See:

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

default_space_settings

A collection of settings that apply to spaces created in the domain.

See:

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

default_user_settings

The default user settings.

See:

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

domain_name

The domain name.

See:

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

domain_settings

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

See:

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

kms_key_id

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.

For more control, specify a customer managed CMK.

Length Constraints : Maximum length of 2048.

Pattern : .*

See:

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

subnet_ids

The VPC subnets that Studio uses for communication.

Length Constraints : Maximum length of 32.

Array members : Minimum number of 1 item. Maximum number of 16 items.

Pattern : [-0-9a-zA-Z]+

See:

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

tags

Tags to associated with the Domain.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all apps that are launched in the Domain.

Array members : Minimum number of 0 items. Maximum number of 50 items.

See:

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

vpc_id

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Length Constraints : Maximum length of 32.

Pattern : [-0-9a-zA-Z]+

See:

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