Class CfnUserProfileMixinProps

Properties for CfnUserProfilePropsMixin.

Inheritance

object

CfnUserProfileMixinProps

Implements

ICfnUserProfileMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnUserProfileMixinProps : ICfnUserProfileMixinProps

Syntax (vb)

Public Class CfnUserProfileMixinProps Implements ICfnUserProfileMixinProps

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.Mixins.Preview.AWS.SageMaker.Mixins;

             var cfnUserProfileMixinProps = new CfnUserProfileMixinProps {
                 DomainId = "domainId",
                 SingleSignOnUserIdentifier = "singleSignOnUserIdentifier",
                 SingleSignOnUserValue = "singleSignOnUserValue",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserProfileName = "userProfileName",
                 UserSettings = new UserSettingsProperty {
                     AutoMountHomeEfs = "autoMountHomeEfs",
                     CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
                         AppLifecycleManagement = new AppLifecycleManagementProperty {
                             IdleSettings = new IdleSettingsProperty {
                                 IdleTimeoutInMinutes = 123,
                                 LifecycleManagement = "lifecycleManagement",
                                 MaxIdleTimeoutInMinutes = 123,
                                 MinIdleTimeoutInMinutes = 123
                             }
                         },
                         BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                         CustomImages = new [] { new CustomImageProperty {
                             AppImageConfigName = "appImageConfigName",
                             ImageName = "imageName",
                             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",
                             FileSystemPath = "fileSystemPath"
                         },
                         FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
                             FileSystemId = "fileSystemId",
                             FileSystemPath = "fileSystemPath"
                         },
                         S3FileSystemConfig = new S3FileSystemConfigProperty {
                             MountPath = "mountPath",
                             S3Uri = "s3Uri"
                         }
                     } },
                     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
                             }
                         },
                         BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                         CodeRepositories = new [] { new CodeRepositoryProperty {
                             RepositoryUrl = "repositoryUrl"
                         } },
                         CustomImages = new [] { new CustomImageProperty {
                             AppImageConfigName = "appImageConfigName",
                             ImageName = "imageName",
                             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",
                             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" },
                         HiddenInstanceTypes = new [] { "hiddenInstanceTypes" },
                         HiddenMlTools = new [] { "hiddenMlTools" },
                         HiddenSageMakerImageVersionAliases = new [] { new HiddenSageMakerImageProperty {
                             SageMakerImageName = "sageMakerImageName",
                             VersionAliases = new [] { "versionAliases" }
                         } }
                     }
                 }
             };

Synopsis

Constructors

CfnUserProfileMixinProps()

Properties for CfnUserProfilePropsMixin.

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

CfnUserProfileMixinProps()

Properties for CfnUserProfilePropsMixin.

public CfnUserProfileMixinProps()

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.Mixins.Preview.AWS.SageMaker.Mixins;

             var cfnUserProfileMixinProps = new CfnUserProfileMixinProps {
                 DomainId = "domainId",
                 SingleSignOnUserIdentifier = "singleSignOnUserIdentifier",
                 SingleSignOnUserValue = "singleSignOnUserValue",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserProfileName = "userProfileName",
                 UserSettings = new UserSettingsProperty {
                     AutoMountHomeEfs = "autoMountHomeEfs",
                     CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
                         AppLifecycleManagement = new AppLifecycleManagementProperty {
                             IdleSettings = new IdleSettingsProperty {
                                 IdleTimeoutInMinutes = 123,
                                 LifecycleManagement = "lifecycleManagement",
                                 MaxIdleTimeoutInMinutes = 123,
                                 MinIdleTimeoutInMinutes = 123
                             }
                         },
                         BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                         CustomImages = new [] { new CustomImageProperty {
                             AppImageConfigName = "appImageConfigName",
                             ImageName = "imageName",
                             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",
                             FileSystemPath = "fileSystemPath"
                         },
                         FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
                             FileSystemId = "fileSystemId",
                             FileSystemPath = "fileSystemPath"
                         },
                         S3FileSystemConfig = new S3FileSystemConfigProperty {
                             MountPath = "mountPath",
                             S3Uri = "s3Uri"
                         }
                     } },
                     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
                             }
                         },
                         BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
                         CodeRepositories = new [] { new CodeRepositoryProperty {
                             RepositoryUrl = "repositoryUrl"
                         } },
                         CustomImages = new [] { new CustomImageProperty {
                             AppImageConfigName = "appImageConfigName",
                             ImageName = "imageName",
                             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",
                             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" },
                         HiddenInstanceTypes = new [] { "hiddenInstanceTypes" },
                         HiddenMlTools = new [] { "hiddenMlTools" },
                         HiddenSageMakerImageVersionAliases = new [] { new HiddenSageMakerImageProperty {
                             SageMakerImageName = "sageMakerImageName",
                             VersionAliases = new [] { "versionAliases" }
                         } }
                     }
                 }
             };

Properties

DomainId

The domain ID.

public string? DomainId { get; set; }

Property Value

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.

public string? SingleSignOnUserIdentifier { get; set; }

Property Value

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.

public string? SingleSignOnUserValue { get; set; }

Property Value

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.

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 .

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

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.

public object? UserSettings { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnUserProfilePropsMixin.IUserSettingsProperty

Implements

ICfnUserProfileMixinProps