Interface ICfnUserProfileProps

Properties for defining a CfnUserProfile.

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public interface ICfnUserProfileProps

Syntax (vb)

Public Interface ICfnUserProfileProps

Remarks

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

CfnUserProfileProps 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 {
        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

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

Link: 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 SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.

Link: 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 SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.

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

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

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

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