Interface ICfnUserProfileProps

Properties for defining a CfnUserProfile.

Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnUserProfileProps
Syntax (vb)
Public Interface ICfnUserProfileProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.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 cfnUserProfileProps = new CfnUserProfileProps {
    DomainId = "domainId",
    UserProfileName = "userProfileName",

    // the properties below are optional
    SingleSignOnUserIdentifier = "singleSignOnUserIdentifier",
    SingleSignOnUserValue = "singleSignOnUserValue",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserSettings = new UserSettingsProperty {
        CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
            AppLifecycleManagement = new AppLifecycleManagementProperty {
                IdleSettings = new IdleSettingsProperty {
                    IdleTimeoutInMinutes = 123,
                    LifecycleManagement = "lifecycleManagement",
                    MaxIdleTimeoutInMinutes = 123,
                    MinIdleTimeoutInMinutes = 123
                }
            },
            CustomImages = new [] { new CustomImageProperty {
                AppImageConfigName = "appImageConfigName",
                ImageName = "imageName",

                // the properties below are optional
                ImageVersionNumber = 123
            } },
            DefaultResourceSpec = new ResourceSpecProperty {
                InstanceType = "instanceType",
                LifecycleConfigArn = "lifecycleConfigArn",
                SageMakerImageArn = "sageMakerImageArn",
                SageMakerImageVersionArn = "sageMakerImageVersionArn"
            },
            LifecycleConfigArns = new [] { "lifecycleConfigArns" }
        },
        CustomFileSystemConfigs = new [] { new CustomFileSystemConfigProperty {
            EfsFileSystemConfig = new EFSFileSystemConfigProperty {
                FileSystemId = "fileSystemId",

                // the properties below are optional
                FileSystemPath = "fileSystemPath"
            },
            FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
                FileSystemId = "fileSystemId",

                // the properties below are optional
                FileSystemPath = "fileSystemPath"
            }
        } },
        CustomPosixUserConfig = new CustomPosixUserConfigProperty {
            Gid = 123,
            Uid = 123
        },
        DefaultLandingUri = "defaultLandingUri",
        ExecutionRole = "executionRole",
        JupyterLabAppSettings = new JupyterLabAppSettingsProperty {
            AppLifecycleManagement = new AppLifecycleManagementProperty {
                IdleSettings = new IdleSettingsProperty {
                    IdleTimeoutInMinutes = 123,
                    LifecycleManagement = "lifecycleManagement",
                    MaxIdleTimeoutInMinutes = 123,
                    MinIdleTimeoutInMinutes = 123
                }
            },
            CodeRepositories = new [] { new CodeRepositoryProperty {
                RepositoryUrl = "repositoryUrl"
            } },
            CustomImages = new [] { new CustomImageProperty {
                AppImageConfigName = "appImageConfigName",
                ImageName = "imageName",

                // the properties below are optional
                ImageVersionNumber = 123
            } },
            DefaultResourceSpec = new ResourceSpecProperty {
                InstanceType = "instanceType",
                LifecycleConfigArn = "lifecycleConfigArn",
                SageMakerImageArn = "sageMakerImageArn",
                SageMakerImageVersionArn = "sageMakerImageVersionArn"
            },
            LifecycleConfigArns = new [] { "lifecycleConfigArns" }
        },
        JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
            DefaultResourceSpec = new ResourceSpecProperty {
                InstanceType = "instanceType",
                LifecycleConfigArn = "lifecycleConfigArn",
                SageMakerImageArn = "sageMakerImageArn",
                SageMakerImageVersionArn = "sageMakerImageVersionArn"
            },
            LifecycleConfigArns = new [] { "lifecycleConfigArns" }
        },
        KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
            CustomImages = new [] { new CustomImageProperty {
                AppImageConfigName = "appImageConfigName",
                ImageName = "imageName",

                // the properties below are optional
                ImageVersionNumber = 123
            } },
            DefaultResourceSpec = new ResourceSpecProperty {
                InstanceType = "instanceType",
                LifecycleConfigArn = "lifecycleConfigArn",
                SageMakerImageArn = "sageMakerImageArn",
                SageMakerImageVersionArn = "sageMakerImageVersionArn"
            },
            LifecycleConfigArns = new [] { "lifecycleConfigArns" }
        },
        RStudioServerProAppSettings = new RStudioServerProAppSettingsProperty {
            AccessStatus = "accessStatus",
            UserGroup = "userGroup"
        },
        SecurityGroups = new [] { "securityGroups" },
        SharingSettings = new SharingSettingsProperty {
            NotebookOutputOption = "notebookOutputOption",
            S3KmsKeyId = "s3KmsKeyId",
            S3OutputPath = "s3OutputPath"
        },
        SpaceStorageSettings = new DefaultSpaceStorageSettingsProperty {
            DefaultEbsStorageSettings = new DefaultEbsStorageSettingsProperty {
                DefaultEbsVolumeSizeInGb = 123,
                MaximumEbsVolumeSizeInGb = 123
            }
        },
        StudioWebPortal = "studioWebPortal",
        StudioWebPortalSettings = new StudioWebPortalSettingsProperty {
            HiddenAppTypes = new [] { "hiddenAppTypes" },
            HiddenMlTools = new [] { "hiddenMlTools" }
        }
    }
};

Synopsis

Properties

DomainId

The domain ID.
SingleSignOnUserIdentifier

A specifier for the type of value specified in SingleSignOnUserValue.
SingleSignOnUserValue

The username of the associated AWS Single Sign-On User for this UserProfile.
Tags

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

The user profile name.
UserSettings

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

Properties

DomainId

The domain ID.

string DomainId { get; }
Property Value

System.String

Remarks

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

SingleSignOnUserIdentifier

A specifier for the type of value specified in SingleSignOnUserValue.

virtual string SingleSignOnUserIdentifier { get; }
Property Value

System.String

Remarks

Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center , this field is required. If the Domain's AuthMode is not IAM Identity Center , this field cannot be specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuseridentifier

SingleSignOnUserValue

The username of the associated AWS Single Sign-On User for this UserProfile.

virtual string SingleSignOnUserValue { get; }
Property Value

System.String

Remarks

If the Domain's AuthMode is IAM Identity Center , this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center , this field cannot be specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-singlesignonuservalue

Tags

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

virtual ICfnTag[] Tags { get; }
Property Value

ICfnTag[]

Remarks

Tags that you specify for the User Profile are also added to all apps that the User Profile launches.

For more information, see Tag .

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

UserProfileName

The user profile name.

string UserProfileName { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-userprofilename

UserSettings

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

virtual object UserSettings { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html#cfn-sagemaker-userprofile-usersettings