software.amazon.awscdk.services.sagemaker

Interface CfnUserProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.157Z")
 @Stability(value=Stable)
public interface CfnUserProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::SageMaker::UserProfile`.

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()
                 .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())
                 .securityGroups(List.of("securityGroups"))
                 .sharingSettings(SharingSettingsProperty.builder()
                         .notebookOutputOption("notebookOutputOption")
                         .s3KmsKeyId("s3KmsKeyId")
                         .s3OutputPath("s3OutputPath")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserProfileProps.Builder A builder for CfnUserProfileProps
static class	CfnUserProfileProps.Jsii$Proxy An implementation for CfnUserProfileProps

Method Summary

Modifier and Type	Method and Description
static CfnUserProfileProps.Builder	builder()
String	getDomainId() `AWS::SageMaker::UserProfile.DomainId`.
default String	getSingleSignOnUserIdentifier() `AWS::SageMaker::UserProfile.SingleSignOnUserIdentifier`.
default String	getSingleSignOnUserValue() `AWS::SageMaker::UserProfile.SingleSignOnUserValue`.
default List<CfnTag>	getTags() `AWS::SageMaker::UserProfile.Tags`.
String	getUserProfileName() `AWS::SageMaker::UserProfile.UserProfileName`.
default Object	getUserSettings() `AWS::SageMaker::UserProfile.UserSettings`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainId

@Stability(value=Stable)
 @NotNull
String getDomainId()

`AWS::SageMaker::UserProfile.DomainId`.

getSingleSignOnUserIdentifier

@Stability(value=Stable)
 @Nullable
default String getSingleSignOnUserIdentifier()

`AWS::SageMaker::UserProfile.SingleSignOnUserIdentifier`.

getSingleSignOnUserValue

@Stability(value=Stable)
 @Nullable
default String getSingleSignOnUserValue()

`AWS::SageMaker::UserProfile.SingleSignOnUserValue`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::SageMaker::UserProfile.Tags`.

getUserProfileName

@Stability(value=Stable)
 @NotNull
String getUserProfileName()

`AWS::SageMaker::UserProfile.UserProfileName`.

getUserSettings

@Stability(value=Stable)
 @Nullable
default Object getUserSettings()

`AWS::SageMaker::UserProfile.UserSettings`.

builder

@Stability(value=Stable)
static CfnUserProfileProps.Builder builder()

Returns:

a CfnUserProfileProps.Builder of CfnUserProfileProps