Class CfnUserProfile.UserSettingsProperty

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

Inheritance

System.Object

CfnUserProfile.UserSettingsProperty

Implements

CfnUserProfile.IUserSettingsProperty

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public class UserSettingsProperty : Object, CfnUserProfile.IUserSettingsProperty

Syntax (vb)

Public Class UserSettingsProperty
    Inherits Object
    Implements CfnUserProfile.IUserSettingsProperty

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-usersettings.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var userSettingsProperty = new UserSettingsProperty {
    ExecutionRole = "executionRole",
    JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn"
        }
    },
    KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
        CustomImages = new [] { new CustomImageProperty {
            AppImageConfigName = "appImageConfigName",
            ImageName = "imageName",

            // the properties below are optional
            ImageVersionNumber = 123
        } },
        DefaultResourceSpec = new ResourceSpecProperty {
            InstanceType = "instanceType",
            SageMakerImageArn = "sageMakerImageArn",
            SageMakerImageVersionArn = "sageMakerImageVersionArn"
        }
    },
    RStudioServerProAppSettings = new RStudioServerProAppSettingsProperty {
        AccessStatus = "accessStatus",
        UserGroup = "userGroup"
    },
    SecurityGroups = new [] { "securityGroups" },
    SharingSettings = new SharingSettingsProperty {
        NotebookOutputOption = "notebookOutputOption",
        S3KmsKeyId = "s3KmsKeyId",
        S3OutputPath = "s3OutputPath"
    }
};

Synopsis

Constructors

UserSettingsProperty()

Properties

ExecutionRole	The execution role for the user.
JupyterServerAppSettings	The Jupyter server's app settings.
KernelGatewayAppSettings	The kernel gateway app settings.
RStudioServerProAppSettings	A collection of settings that configure user interaction with the `RStudioServerPro` app.
SecurityGroups	The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
SharingSettings	Specifies options for sharing SageMaker Studio notebooks.

Constructors

UserSettingsProperty()

public UserSettingsProperty()

Properties

ExecutionRole

The execution role for the user.

public string ExecutionRole { get; set; }

Property Value

System.String

Remarks

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

JupyterServerAppSettings

The Jupyter server's app settings.

public object JupyterServerAppSettings { get; set; }

Property Value

System.Object

Remarks

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

KernelGatewayAppSettings

The kernel gateway app settings.

public object KernelGatewayAppSettings { get; set; }

Property Value

System.Object

Remarks

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

RStudioServerProAppSettings

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

public object RStudioServerProAppSettings { get; set; }

Property Value

System.Object

Remarks

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

SecurityGroups

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

public string[] SecurityGroups { get; set; }

Property Value

System.String[]

Remarks

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-userprofile-usersettings.html#cfn-sagemaker-userprofile-usersettings-securitygroups

SharingSettings

Specifies options for sharing SageMaker Studio notebooks.

public object SharingSettings { get; set; }

Property Value

System.Object

Remarks

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

Implements

CfnUserProfile.IUserSettingsProperty