Class CfnUserProfile
A CloudFormation AWS::SageMaker::UserProfile
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnUserProfile : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserProfile
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center , a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
If you're using IAM Identity Center authentication, a user in IAM Identity Center , or a group in IAM Identity Center containing that user, must be assigned to the Amazon SageMaker Studio application from the IAM Identity Center Console to create a user profile. For more information about application assignment, see Assign user access . After assignment is complete, a user profile can be created for that user in IAM Identity Center with AWS CloudFormation.
CloudformationResource: AWS::SageMaker::UserProfile
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 cfnUserProfile = new CfnUserProfile(this, "MyCfnUserProfile", 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
CfnUserProfile(Construct, String, ICfnUserProfileProps) | Create a new |
CfnUserProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrUserProfileArn | The Amazon Resource Name (ARN) of the user profile, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserProfile(Construct, String, ICfnUserProfileProps)
Create a new AWS::SageMaker::UserProfile
.
public CfnUserProfile(Construct scope, string id, ICfnUserProfileProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserProfileProps
- resource properties.
CfnUserProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrUserProfileArn
The Amazon Resource Name (ARN) of the user profile, such as arn:aws:sagemaker:us-west-2:account-id:user-profile/my-user-profile
.
public virtual string AttrUserProfileArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UserProfileArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainId
The domain ID.
public virtual string DomainId { get; set; }
Property Value
System.String
Remarks
SingleSignOnUserIdentifier
A specifier for the type of value specified in SingleSignOnUserValue.
public virtual 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.
SingleSignOnUserValue
The username of the associated AWS Single Sign-On User for this UserProfile.
public virtual 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.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
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 .
UserProfileName
The user profile name.
public virtual string UserProfileName { get; set; }
Property Value
System.String
Remarks
UserSettings
A collection of settings that apply to users of Amazon SageMaker Studio.
public virtual object UserSettings { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>