Interface CfnUserProfileProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUserProfileProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:23.436Z")
@Stability(Stable)
public interface CfnUserProfileProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnUserProfile
.
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.*; CfnUserProfileProps cfnUserProfileProps = CfnUserProfileProps.builder() .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() .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder() .customImages(List.of(CustomImageProperty.builder() .appImageConfigName("appImageConfigName") .imageName("imageName") // the properties below are optional .imageVersionNumber(123) .build())) .defaultResourceSpec(ResourceSpecProperty.builder() .instanceType("instanceType") .lifecycleConfigArn("lifecycleConfigArn") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .lifecycleConfigArns(List.of("lifecycleConfigArns")) .build()) .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder() .efsFileSystemConfig(EFSFileSystemConfigProperty.builder() .fileSystemId("fileSystemId") // the properties below are optional .fileSystemPath("fileSystemPath") .build()) .build())) .customPosixUserConfig(CustomPosixUserConfigProperty.builder() .gid(123) .uid(123) .build()) .defaultLandingUri("defaultLandingUri") .executionRole("executionRole") .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder() .codeRepositories(List.of(CodeRepositoryProperty.builder() .repositoryUrl("repositoryUrl") .build())) .customImages(List.of(CustomImageProperty.builder() .appImageConfigName("appImageConfigName") .imageName("imageName") // the properties below are optional .imageVersionNumber(123) .build())) .defaultResourceSpec(ResourceSpecProperty.builder() .instanceType("instanceType") .lifecycleConfigArn("lifecycleConfigArn") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .lifecycleConfigArns(List.of("lifecycleConfigArns")) .build()) .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder() .defaultResourceSpec(ResourceSpecProperty.builder() .instanceType("instanceType") .lifecycleConfigArn("lifecycleConfigArn") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .lifecycleConfigArns(List.of("lifecycleConfigArns")) .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") .lifecycleConfigArn("lifecycleConfigArn") .sageMakerImageArn("sageMakerImageArn") .sageMakerImageVersionArn("sageMakerImageVersionArn") .build()) .lifecycleConfigArns(List.of("lifecycleConfigArns")) .build()) .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder() .accessStatus("accessStatus") .userGroup("userGroup") .build()) .securityGroups(List.of("securityGroups")) .sharingSettings(SharingSettingsProperty.builder() .notebookOutputOption("notebookOutputOption") .s3KmsKeyId("s3KmsKeyId") .s3OutputPath("s3OutputPath") .build()) .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder() .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder() .defaultEbsVolumeSizeInGb(123) .maximumEbsVolumeSizeInGb(123) .build()) .build()) .studioWebPortal("studioWebPortal") .studioWebPortalSettings(StudioWebPortalSettingsProperty.builder() .hiddenAppTypes(List.of("hiddenAppTypes")) .hiddenMlTools(List.of("hiddenMlTools")) .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserProfileProps
static final class
An implementation forCfnUserProfileProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnUserProfileProps.Builder
builder()
The domain ID.default String
A specifier for the type of value specified in SingleSignOnUserValue.default String
The username of the associated AWS Single Sign-On User for this UserProfile.getTags()
An array of key-value pairs to apply to this resource.The user profile name.default Object
A collection of settings that apply to users of Amazon SageMaker Studio.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDomainId
The domain ID.- See Also:
-
getUserProfileName
The user profile name.- See Also:
-
getSingleSignOnUserIdentifier
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.
- See Also:
-
getSingleSignOnUserValue
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.
- See Also:
-
getTags
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 .
- See Also:
-
getUserSettings
A collection of settings that apply to users of Amazon SageMaker Studio.- See Also:
-
builder
- Returns:
- a
CfnUserProfileProps.Builder
ofCfnUserProfileProps
-