CfnDomain

class aws_cdk.aws_sagemaker.CfnDomain(scope, id, *, 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: CfnResource

A CloudFormation AWS::SageMaker::Domain.

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) 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 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 SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio 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 Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker 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 SageMaker Studio app successfully.

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

CloudformationResource:: AWS::SageMaker::Domain
Link:: 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.
import aws_cdk.aws_sagemaker as sagemaker

cfn_domain = sagemaker.CfnDomain(self, "MyCfnDomain",
    auth_mode="authMode",
    default_user_settings=sagemaker.CfnDomain.UserSettingsProperty(
        execution_role="executionRole",

        # the properties below are optional
        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"
            )
        ),
        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"
            )
        ),
        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"
        )
    ),
    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
        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"
            )
        ),
        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"
            )
        ),
        security_groups=["securityGroups"]
    ),
    domain_settings=sagemaker.CfnDomain.DomainSettingsProperty(
        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"
    )]
)

Create a new AWS::SageMaker::Domain.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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]) – AWS::SageMaker::Domain.DefaultSpaceSettings.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

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

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

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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

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

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example:

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

would add the overrides Example:

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

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

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

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

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

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

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

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

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

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

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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

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

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SageMaker::Domain'

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

Link:: 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

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

attr_domain_arn

The Amazon Resource Name (ARN) of the Domain, such as arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name .

CloudformationAttribute:: DomainArn

attr_domain_id

The Domain ID.

CloudformationAttribute:: DomainId

attr_home_efs_file_system_id

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

CloudformationAttribute:: HomeEfsFileSystemId

attr_security_group_id_for_domain_boundary

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

CloudformationAttribute:: SecurityGroupIdForDomainBoundary

attr_single_sign_on_managed_application_instance_id

The IAM Identity Center managed application instance ID.

CloudformationAttribute:: SingleSignOnManagedApplicationInstanceId

attr_url

The URL for the Domain.

CloudformationAttribute:: Url

auth_mode

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

Valid Values : SSO | IAM

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

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

cfn_resource_type: AWS resource type.

creation_stack

return:

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

default_space_settings

AWS::SageMaker::Domain.DefaultSpaceSettings.

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

default_user_settings

The default user settings.

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

domain_name

The domain name.

Link:: 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.

Link:: 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 : .*

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

logical_id

The logical ID for this CloudFormation stack element.

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

To override this value, use overrideLogicalId(newLogicalId).

Returns:

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

node: The construct tree node associated with this construct.

ref

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

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

stack

The stack in which this element is defined.

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

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]+

Link:: 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.

Link:: 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]+

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

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters:

x (Any) –

Return type:

bool

Returns:

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

CustomImageProperty

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

Bases: object

A custom SageMaker image.

For more information, see Bring your own SageMaker image .

Parameters:

app_image_config_name (str) – The name of the AppImageConfig.
image_name (str) – The name of the CustomImage. Must be unique to your account.
image_version_number (Union[int, float, None]) – The version number of the CustomImage.

Link:

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

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

    # the properties below are optional
    image_version_number=123
)

Attributes

app_image_config_name

The name of the AppImageConfig.

Link:: 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.

Link:: 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.

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

DefaultSpaceSettingsProperty

class CfnDomain.DefaultSpaceSettingsProperty(*, execution_role, jupyter_server_app_settings=None, kernel_gateway_app_settings=None, security_groups=None)

Bases: object

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

Parameters:

execution_role (str) – The ARN of the execution role for the space.
jupyter_server_app_settings (Union[IResolvable, JupyterServerAppSettingsProperty, Dict[str, Any], None]) – The JupyterServer app settings.
kernel_gateway_app_settings (Union[IResolvable, KernelGatewayAppSettingsProperty, Dict[str, Any], None]) – The KernelGateway app settings.
security_groups (Optional[Sequence[str]]) – The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

Link:

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

default_space_settings_property = sagemaker.CfnDomain.DefaultSpaceSettingsProperty(
    execution_role="executionRole",

    # the properties below are optional
    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"
        )
    ),
    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"
        )
    ),
    security_groups=["securityGroups"]
)

Attributes

execution_role

The ARN of the execution role for the space.

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

jupyter_server_app_settings

The JupyterServer app settings.

Link:: 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.

Link:: 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 Virtual Private Cloud that the space uses for communication.

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

DomainSettingsProperty

class CfnDomain.DomainSettingsProperty(*, r_studio_server_pro_domain_settings=None, security_group_ids=None)

Bases: object

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Parameters:

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.

Link:

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

domain_settings_property = sagemaker.CfnDomain.DomainSettingsProperty(
    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"]
)

Attributes

r_studio_server_pro_domain_settings

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

Link:: 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.

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

JupyterServerAppSettingsProperty

class CfnDomain.JupyterServerAppSettingsProperty(*, default_resource_spec=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.
Link:: 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.
import aws_cdk.aws_sagemaker as sagemaker

jupyter_server_app_settings_property = 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"
    )
)

Attributes

default_resource_spec

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

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

KernelGatewayAppSettingsProperty

class CfnDomain.KernelGatewayAppSettingsProperty(*, custom_images=None, default_resource_spec=None)

Bases: object

The KernelGateway app settings.

Parameters:

custom_images (Union[IResolvable, Sequence[Union[IResolvable, CustomImageProperty, Dict[str, Any]]], None]) – A list of custom SageMaker images that are configured to run as a KernelGateway app.
default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. .. epigraph:: The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS Command Line Interface or AWS CloudFormation and the instance type parameter value is not passed.

Link:

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

kernel_gateway_app_settings_property = 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"
    )
)

Attributes

custom_images

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

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

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

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

RSessionAppSettingsProperty

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

Link:

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

r_session_app_settings_property = 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"
    )
)

Attributes

custom_images

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

Link:: 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.

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

RStudioServerProAppSettingsProperty

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

Link:

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

r_studio_server_pro_app_settings_property = sagemaker.CfnDomain.RStudioServerProAppSettingsProperty(
    access_status="accessStatus",
    user_group="userGroup"
)

Attributes

access_status

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

Link:: 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.

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

RStudioServerProDomainSettingsProperty

class CfnDomain.RStudioServerProDomainSettingsProperty(*, domain_execution_role_arn, default_resource_spec=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:

domain_execution_role_arn (str) – The ARN of the execution role for the RStudioServerPro Domain-level app.
default_resource_spec (Union[IResolvable, ResourceSpecProperty, Dict[str, Any], None]) – A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
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.

Link:

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

r_studio_server_pro_domain_settings_property = 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"
)

Attributes

default_resource_spec

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

Link:: 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.

Link:: 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.

Link:: 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.

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

ResourceSpecProperty

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

Bases: object

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

Parameters:

instance_type (Optional[str]) – The instance type that the image version runs on. .. epigraph:: JupyterServer apps only support the system value. For KernelGateway apps , the system value is translated to ml.t3.medium . KernelGateway apps also support all other values for available instance types.
lifecycle_config_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
sage_maker_image_arn (Optional[str]) – The ARN of the SageMaker image that the image version belongs to.
sage_maker_image_version_arn (Optional[str]) – The ARN of the image version created on the instance.

Link:

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

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

Link:: 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.

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

Link:: 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.

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

SharingSettingsProperty

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

Link:

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

sharing_settings_property = sagemaker.CfnDomain.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 .

Link:: 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.

Link:: 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.

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

UserSettingsProperty

class CfnDomain.UserSettingsProperty(*, execution_role, 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)

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:

execution_role (str) – The execution role for the user.
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 Studio 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 adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
sharing_settings (Union[IResolvable, SharingSettingsProperty, Dict[str, Any], None]) – Specifies options for sharing SageMaker Studio notebooks.

Link:

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

user_settings_property = sagemaker.CfnDomain.UserSettingsProperty(
    execution_role="executionRole",

    # the properties below are optional
    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"
        )
    ),
    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"
        )
    ),
    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"
    )
)

Attributes

execution_role

The execution role for the user.

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

jupyter_server_app_settings

The Jupyter server’s app settings.

Link:: 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.

Link:: 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.

Link:: 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.

Link:: 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 Studio 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 adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

Link:: 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 SageMaker Studio notebooks.

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