CfnUserProfileProps¶
-
class
aws_cdk.aws_sagemaker.
CfnUserProfileProps
(*, domain_id, user_profile_name, single_sign_on_user_identifier=None, single_sign_on_user_value=None, tags=None, user_settings=None)¶ Bases:
object
Properties for defining a
CfnUserProfile
.- Parameters
domain_id (
str
) – The domain ID.user_profile_name (
str
) – The user profile name.single_sign_on_user_identifier (
Optional
[str
]) – A specifier for the type of value specified in SingleSignOnUserValue. 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.single_sign_on_user_value (
Optional
[str
]) – The username of the associated AWS Single Sign-On User for this UserProfile. 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.tags (
Optional
[Sequence
[CfnTag
]]) – An array of key-value pairs to apply to this resource. Tags that you specify for the User Profile are also added to all apps that the User Profile launches. For more information, see Tag .user_settings (
Union
[IResolvable
,UserSettingsProperty
,None
]) – A collection of settings that apply to users of Amazon SageMaker Studio.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sagemaker as sagemaker cfn_user_profile_props = sagemaker.CfnUserProfileProps( domain_id="domainId", user_profile_name="userProfileName", # the properties below are optional single_sign_on_user_identifier="singleSignOnUserIdentifier", single_sign_on_user_value="singleSignOnUserValue", tags=[CfnTag( key="key", value="value" )], user_settings=sagemaker.CfnUserProfile.UserSettingsProperty( execution_role="executionRole", jupyter_server_app_settings=sagemaker.CfnUserProfile.JupyterServerAppSettingsProperty( default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), kernel_gateway_app_settings=sagemaker.CfnUserProfile.KernelGatewayAppSettingsProperty( custom_images=[sagemaker.CfnUserProfile.CustomImageProperty( app_image_config_name="appImageConfigName", image_name="imageName", # the properties below are optional image_version_number=123 )], default_resource_spec=sagemaker.CfnUserProfile.ResourceSpecProperty( instance_type="instanceType", sage_maker_image_arn="sageMakerImageArn", sage_maker_image_version_arn="sageMakerImageVersionArn" ) ), r_studio_server_pro_app_settings=sagemaker.CfnUserProfile.RStudioServerProAppSettingsProperty( access_status="accessStatus", user_group="userGroup" ), security_groups=["securityGroups"], sharing_settings=sagemaker.CfnUserProfile.SharingSettingsProperty( notebook_output_option="notebookOutputOption", s3_kms_key_id="s3KmsKeyId", s3_output_path="s3OutputPath" ) ) )
Attributes
-
domain_id
¶ The domain ID.
-
single_sign_on_user_identifier
¶ A specifier for the type of value specified in SingleSignOnUserValue.
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.
-
single_sign_on_user_value
¶ The username of the associated AWS Single Sign-On User for this UserProfile.
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.
An array of key-value pairs to apply to this resource.
Tags that you specify for the User Profile are also added to all apps that the User Profile launches.
For more information, see Tag .
-
user_profile_name
¶ The user profile name.
-
user_settings
¶ A collection of settings that apply to users of Amazon SageMaker Studio.