Class CfnUserProfileProps

Properties for defining a CfnUserProfile.

Inheritance

System.Object

CfnUserProfileProps

Implements

ICfnUserProfileProps

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public class CfnUserProfileProps : Object, ICfnUserProfileProps

Syntax (vb)

Public Class CfnUserProfileProps
    Inherits Object
    Implements 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;

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

CfnUserProfileProps()

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.

Constructors

CfnUserProfileProps()

public CfnUserProfileProps()

Properties

DomainId

The domain ID.

public string DomainId { get; set; }

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.

public string SingleSignOnUserIdentifier { get; set; }

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.

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.

public string SingleSignOnUserValue { get; set; }

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.

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.

public ICfnTag[] Tags { get; set; }

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.

public string UserProfileName { get; set; }

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.

public object UserSettings { get; set; }

Property Value

System.Object

Remarks

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

Implements

ICfnUserProfileProps