@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.982Z") public class CfnUserProfile extends CfnResource implements IInspectable
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.sagemaker.*; CfnUserProfile cfnUserProfile = CfnUserProfile.Builder.create(this, "MyCfnUserProfile") .domainId("domainId") .userProfileName("userProfileName") // the properties below are optional .singleSignOnUserIdentifier("singleSignOnUserIdentifier") .singleSignOnUserValue("singleSignOnUserValue") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .userSettings(UserSettingsProperty.builder() .executionRole("executionRole") .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder() .defaultResourceSpec(ResourceSpecProperty.builder() .instanceType("instanceType") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .build()) .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder() .customImages(List.of(CustomImageProperty.builder() .appImageConfigName("appImageConfigName") .imageName("imageName") // the properties below are optional .imageVersionNumber(123) .build())) .defaultResourceSpec(ResourceSpecProperty.builder() .instanceType("instanceType") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .build()) .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder() .accessStatus("accessStatus") .userGroup("userGroup") .build()) .securityGroups(List.of("securityGroups")) .sharingSettings(SharingSettingsProperty.builder() .notebookOutputOption("notebookOutputOption") .s3KmsKeyId("s3KmsKeyId") .s3OutputPath("s3OutputPath") .build()) .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUserProfile.Builder
A fluent builder for
CfnUserProfile . |
static interface |
CfnUserProfile.CustomImageProperty
A custom SageMaker image.
|
static interface |
CfnUserProfile.JupyterServerAppSettingsProperty
The JupyterServer app settings.
|
static interface |
CfnUserProfile.KernelGatewayAppSettingsProperty
The KernelGateway app settings.
|
static interface |
CfnUserProfile.ResourceSpecProperty
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
|
static interface |
CfnUserProfile.RStudioServerProAppSettingsProperty
A collection of settings that configure user interaction with the `RStudioServerPro` app.
|
static interface |
CfnUserProfile.SharingSettingsProperty
Specifies options when sharing an Amazon SageMaker Studio notebook.
|
static interface |
CfnUserProfile.UserSettingsProperty
A collection of settings that apply to users of Amazon SageMaker Studio.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnUserProfile(Construct scope,
java.lang.String id,
CfnUserProfileProps props)
Create a new `AWS::SageMaker::UserProfile`.
|
protected |
CfnUserProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnUserProfile(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrUserProfileArn()
The Amazon Resource Name (ARN) of the user profile, such as `arn:aws:sagemaker:us-west-2:account-id:user-profile/my-user-profile` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainId()
The domain ID.
|
java.lang.String |
getSingleSignOnUserIdentifier()
A specifier for the type of value specified in SingleSignOnUserValue.
|
java.lang.String |
getSingleSignOnUserValue()
The username of the associated AWS Single Sign-On User for this UserProfile.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getUserProfileName()
The user profile name.
|
java.lang.Object |
getUserSettings()
A collection of settings that apply to users of Amazon SageMaker Studio.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDomainId(java.lang.String value)
The domain ID.
|
void |
setSingleSignOnUserIdentifier(java.lang.String value)
A specifier for the type of value specified in SingleSignOnUserValue.
|
void |
setSingleSignOnUserValue(java.lang.String value)
The username of the associated AWS Single Sign-On User for this UserProfile.
|
void |
setUserProfileName(java.lang.String value)
The user profile name.
|
void |
setUserSettings(CfnUserProfile.UserSettingsProperty value)
A collection of settings that apply to users of Amazon SageMaker Studio.
|
void |
setUserSettings(IResolvable value)
A collection of settings that apply to users of Amazon SageMaker Studio.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUserProfile(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUserProfile(Construct scope, java.lang.String id, CfnUserProfileProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrUserProfileArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Tags that you specify for the User Profile are also added to all apps that the User Profile launches.
For more information, see Tag .
public java.lang.String getDomainId()
public void setDomainId(java.lang.String value)
public java.lang.String getUserProfileName()
public void setUserProfileName(java.lang.String value)
public java.lang.String getSingleSignOnUserIdentifier()
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.
public void setSingleSignOnUserIdentifier(java.lang.String value)
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.
public java.lang.String getSingleSignOnUserValue()
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.
public void setSingleSignOnUserValue(java.lang.String value)
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.
public java.lang.Object getUserSettings()
public void setUserSettings(IResolvable value)
public void setUserSettings(CfnUserProfile.UserSettingsProperty value)