Package software.amazon.awscdk.services.sagemaker

Class CfnUserProfile.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnUserProfile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserProfile>

Enclosing class:

CfnUserProfile

@Stability(Stable)
public static final class CfnUserProfile.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserProfile>

A fluent builder for CfnUserProfile.

Method Summary

Modifier and Type	Method	Description
CfnUserProfile	build()
static CfnUserProfile.Builder	create(software.constructs.Construct scope, String id)
CfnUserProfile.Builder	domainId(String domainId)	The domain ID.
CfnUserProfile.Builder	singleSignOnUserIdentifier(String singleSignOnUserIdentifier)	A specifier for the type of value specified in SingleSignOnUserValue.
CfnUserProfile.Builder	singleSignOnUserValue(String singleSignOnUserValue)	The username of the associated AWS Single Sign-On User for this UserProfile.
CfnUserProfile.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnUserProfile.Builder	userProfileName(String userProfileName)	The user profile name.
CfnUserProfile.Builder	userSettings(IResolvable userSettings)	A collection of settings that apply to users of Amazon SageMaker Studio.
CfnUserProfile.Builder	userSettings(CfnUserProfile.UserSettingsProperty userSettings)	A collection of settings that apply to users of Amazon SageMaker Studio.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUserProfile.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUserProfile.Builder.

domainId

@Stability(Stable)
public CfnUserProfile.Builder domainId(String domainId)

The domain ID.

Parameters:

domainId - The domain ID. This parameter is required.

Returns:

this

See Also:

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

userProfileName

@Stability(Stable)
public CfnUserProfile.Builder userProfileName(String userProfileName)

The user profile name.

Parameters:

userProfileName - The user profile name. This parameter is required.

Returns:

this

See Also:

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

singleSignOnUserIdentifier

@Stability(Stable)
public CfnUserProfile.Builder singleSignOnUserIdentifier(String singleSignOnUserIdentifier)

A specifier for the type of value specified in SingleSignOnUserValue.

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.

Parameters:

singleSignOnUserIdentifier - A specifier for the type of value specified in SingleSignOnUserValue. This parameter is required.

Returns:

this

See Also:

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

singleSignOnUserValue

@Stability(Stable)
public CfnUserProfile.Builder singleSignOnUserValue(String singleSignOnUserValue)

The username of the associated AWS Single Sign-On User for this UserProfile.

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.

Parameters:

singleSignOnUserValue - The username of the associated AWS Single Sign-On User for this UserProfile. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnUserProfile.Builder tags(List<? extends CfnTag> tags)

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 .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

userSettings

@Stability(Stable)
public CfnUserProfile.Builder userSettings(IResolvable userSettings)

A collection of settings that apply to users of Amazon SageMaker Studio.

Parameters:

userSettings - A collection of settings that apply to users of Amazon SageMaker Studio. This parameter is required.

Returns:

this

See Also:

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

userSettings

@Stability(Stable)
public CfnUserProfile.Builder userSettings(CfnUserProfile.UserSettingsProperty userSettings)

A collection of settings that apply to users of Amazon SageMaker Studio.

Parameters:

userSettings - A collection of settings that apply to users of Amazon SageMaker Studio. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserProfile build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserProfile>

Returns:

a newly built instance of CfnUserProfile.