Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. getUserProfile

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.getUserProfile

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::UserProfile

    Using getUserProfile

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserProfile(args: GetUserProfileArgs, opts?: InvokeOptions): Promise<GetUserProfileResult>
function getUserProfileOutput(args: GetUserProfileOutputArgs, opts?: InvokeOptions): Output<GetUserProfileResult>
    def get_user_profile(domain_id: Optional[str] = None,
                     user_profile_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetUserProfileResult
def get_user_profile_output(domain_id: Optional[pulumi.Input[str]] = None,
                     user_profile_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetUserProfileResult]
    func LookupUserProfile(ctx *Context, args *LookupUserProfileArgs, opts ...InvokeOption) (*LookupUserProfileResult, error)
func LookupUserProfileOutput(ctx *Context, args *LookupUserProfileOutputArgs, opts ...InvokeOption) LookupUserProfileResultOutput

    > Note: This function is named LookupUserProfile in the Go SDK.

    public static class GetUserProfile 
{
    public static Task<GetUserProfileResult> InvokeAsync(GetUserProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetUserProfileResult> Invoke(GetUserProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserProfileResult> getUserProfile(GetUserProfileArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:sagemaker:getUserProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainId string
    The ID of the associated Domain.
    UserProfileName string
    A name for the UserProfile.
    DomainId string
    The ID of the associated Domain.
    UserProfileName string
    A name for the UserProfile.
    domainId String
    The ID of the associated Domain.
    userProfileName String
    A name for the UserProfile.
    domainId string
    The ID of the associated Domain.
    userProfileName string
    A name for the UserProfile.
    domain_id str
    The ID of the associated Domain.
    user_profile_name str
    A name for the UserProfile.
    domainId String
    The ID of the associated Domain.
    userProfileName String
    A name for the UserProfile.

    getUserProfile Result

    The following output properties are available:

    UserProfileArn string
    The user profile Amazon Resource Name (ARN).
    UserSettings Pulumi.AwsNative.SageMaker.Outputs.UserProfileUserSettings
    A collection of settings.
    UserProfileArn string
    The user profile Amazon Resource Name (ARN).
    UserSettings UserProfileUserSettings
    A collection of settings.
    userProfileArn String
    The user profile Amazon Resource Name (ARN).
    userSettings UserProfileUserSettings
    A collection of settings.
    userProfileArn string
    The user profile Amazon Resource Name (ARN).
    userSettings UserProfileUserSettings
    A collection of settings.
    user_profile_arn str
    The user profile Amazon Resource Name (ARN).
    user_settings UserProfileUserSettings
    A collection of settings.
    userProfileArn String
    The user profile Amazon Resource Name (ARN).
    userSettings Property Map
    A collection of settings.

    Supporting Types

    UserProfileAppLifecycleManagement

    IdleSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileIdleSettings
    Settings related to idle shutdown of Studio applications.
    IdleSettings UserProfileIdleSettings
    Settings related to idle shutdown of Studio applications.
    idleSettings UserProfileIdleSettings
    Settings related to idle shutdown of Studio applications.
    idleSettings UserProfileIdleSettings
    Settings related to idle shutdown of Studio applications.
    idle_settings UserProfileIdleSettings
    Settings related to idle shutdown of Studio applications.
    idleSettings Property Map
    Settings related to idle shutdown of Studio applications.

    UserProfileAppType

    UserProfileCodeEditorAppSettings

    AppLifecycleManagement Pulumi.AwsNative.SageMaker.Inputs.UserProfileAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.UserProfileCustomImage>
    A list of custom images for use for CodeEditor apps.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    LifecycleConfigArns List<string>
    A list of LifecycleConfigArns available for use with CodeEditor apps.
    AppLifecycleManagement UserProfileAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    CustomImages []UserProfileCustomImage
    A list of custom images for use for CodeEditor apps.
    DefaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    LifecycleConfigArns []string
    A list of LifecycleConfigArns available for use with CodeEditor apps.
    appLifecycleManagement UserProfileAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    customImages List<UserProfileCustomImage>
    A list of custom images for use for CodeEditor apps.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with CodeEditor apps.
    appLifecycleManagement UserProfileAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    customImages UserProfileCustomImage[]
    A list of custom images for use for CodeEditor apps.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    lifecycleConfigArns string[]
    A list of LifecycleConfigArns available for use with CodeEditor apps.
    app_lifecycle_management UserProfileAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    custom_images Sequence[UserProfileCustomImage]
    A list of custom images for use for CodeEditor apps.
    default_resource_spec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    lifecycle_config_arns Sequence[str]
    A list of LifecycleConfigArns available for use with CodeEditor apps.
    appLifecycleManagement Property Map
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    customImages List<Property Map>
    A list of custom images for use for CodeEditor apps.
    defaultResourceSpec Property Map
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with CodeEditor apps.

    UserProfileCodeRepository

    RepositoryUrl string
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.
    RepositoryUrl string
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.
    repositoryUrl String
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.
    repositoryUrl string
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.
    repository_url str
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.
    repositoryUrl String
    A CodeRepository (valid URL) to be used within Jupyter's Git extension.

    UserProfileCustomFileSystemConfig

    EfsFileSystemConfig UserProfileEfsFileSystemConfig
    The settings for a custom Amazon EFS file system.
    efsFileSystemConfig UserProfileEfsFileSystemConfig
    The settings for a custom Amazon EFS file system.
    efsFileSystemConfig UserProfileEfsFileSystemConfig
    The settings for a custom Amazon EFS file system.
    efs_file_system_config UserProfileEfsFileSystemConfig
    The settings for a custom Amazon EFS file system.
    efsFileSystemConfig Property Map
    The settings for a custom Amazon EFS file system.

    UserProfileCustomImage

    AppImageConfigName string
    The Name of the AppImageConfig.
    ImageName string
    The name of the CustomImage. Must be unique to your account.
    ImageVersionNumber int
    The version number of the CustomImage.
    AppImageConfigName string
    The Name of the AppImageConfig.
    ImageName string
    The name of the CustomImage. Must be unique to your account.
    ImageVersionNumber int
    The version number of the CustomImage.
    appImageConfigName String
    The Name of the AppImageConfig.
    imageName String
    The name of the CustomImage. Must be unique to your account.
    imageVersionNumber Integer
    The version number of the CustomImage.
    appImageConfigName string
    The Name of the AppImageConfig.
    imageName string
    The name of the CustomImage. Must be unique to your account.
    imageVersionNumber number
    The version number of the CustomImage.
    app_image_config_name str
    The Name of the AppImageConfig.
    image_name str
    The name of the CustomImage. Must be unique to your account.
    image_version_number int
    The version number of the CustomImage.
    appImageConfigName String
    The Name of the AppImageConfig.
    imageName String
    The name of the CustomImage. Must be unique to your account.
    imageVersionNumber Number
    The version number of the CustomImage.

    UserProfileCustomPosixUserConfig

    Gid int
    The POSIX group ID.
    Uid int
    The POSIX user ID.
    Gid int
    The POSIX group ID.
    Uid int
    The POSIX user ID.
    gid Integer
    The POSIX group ID.
    uid Integer
    The POSIX user ID.
    gid number
    The POSIX group ID.
    uid number
    The POSIX user ID.
    gid int
    The POSIX group ID.
    uid int
    The POSIX user ID.
    gid Number
    The POSIX group ID.
    uid Number
    The POSIX user ID.

    UserProfileDefaultEbsStorageSettings

    DefaultEbsVolumeSizeInGb int
    Default size of the Amazon EBS volume in Gb
    MaximumEbsVolumeSizeInGb int
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.
    DefaultEbsVolumeSizeInGb int
    Default size of the Amazon EBS volume in Gb
    MaximumEbsVolumeSizeInGb int
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.
    defaultEbsVolumeSizeInGb Integer
    Default size of the Amazon EBS volume in Gb
    maximumEbsVolumeSizeInGb Integer
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.
    defaultEbsVolumeSizeInGb number
    Default size of the Amazon EBS volume in Gb
    maximumEbsVolumeSizeInGb number
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.
    default_ebs_volume_size_in_gb int
    Default size of the Amazon EBS volume in Gb
    maximum_ebs_volume_size_in_gb int
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.
    defaultEbsVolumeSizeInGb Number
    Default size of the Amazon EBS volume in Gb
    maximumEbsVolumeSizeInGb Number
    Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.

    UserProfileDefaultSpaceStorageSettings

    DefaultEbsStorageSettings UserProfileDefaultEbsStorageSettings
    The default EBS storage settings for a space.
    defaultEbsStorageSettings UserProfileDefaultEbsStorageSettings
    The default EBS storage settings for a space.
    defaultEbsStorageSettings UserProfileDefaultEbsStorageSettings
    The default EBS storage settings for a space.
    default_ebs_storage_settings UserProfileDefaultEbsStorageSettings
    The default EBS storage settings for a space.
    defaultEbsStorageSettings Property Map
    The default EBS storage settings for a space.

    UserProfileEfsFileSystemConfig

    FileSystemId string
    The ID of your Amazon EFS file system.
    FileSystemPath string
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
    FileSystemId string
    The ID of your Amazon EFS file system.
    FileSystemPath string
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
    fileSystemId String
    The ID of your Amazon EFS file system.
    fileSystemPath String
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
    fileSystemId string
    The ID of your Amazon EFS file system.
    fileSystemPath string
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
    file_system_id str
    The ID of your Amazon EFS file system.
    file_system_path str
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
    fileSystemId String
    The ID of your Amazon EFS file system.
    fileSystemPath String
    The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.

    UserProfileIdleSettings

    IdleTimeoutInMinutes int
    The time that SageMaker waits after the application becomes idle before shutting it down.
    LifecycleManagement Pulumi.AwsNative.SageMaker.UserProfileLifecycleManagement
    Indicates whether idle shutdown is activated for the application type.
    MaxIdleTimeoutInMinutes int
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    MinIdleTimeoutInMinutes int
    The minimum value in minutes that custom idle shutdown can be set to by the user.
    IdleTimeoutInMinutes int
    The time that SageMaker waits after the application becomes idle before shutting it down.
    LifecycleManagement UserProfileLifecycleManagement
    Indicates whether idle shutdown is activated for the application type.
    MaxIdleTimeoutInMinutes int
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    MinIdleTimeoutInMinutes int
    The minimum value in minutes that custom idle shutdown can be set to by the user.
    idleTimeoutInMinutes Integer
    The time that SageMaker waits after the application becomes idle before shutting it down.
    lifecycleManagement UserProfileLifecycleManagement
    Indicates whether idle shutdown is activated for the application type.
    maxIdleTimeoutInMinutes Integer
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    minIdleTimeoutInMinutes Integer
    The minimum value in minutes that custom idle shutdown can be set to by the user.
    idleTimeoutInMinutes number
    The time that SageMaker waits after the application becomes idle before shutting it down.
    lifecycleManagement UserProfileLifecycleManagement
    Indicates whether idle shutdown is activated for the application type.
    maxIdleTimeoutInMinutes number
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    minIdleTimeoutInMinutes number
    The minimum value in minutes that custom idle shutdown can be set to by the user.
    idle_timeout_in_minutes int
    The time that SageMaker waits after the application becomes idle before shutting it down.
    lifecycle_management UserProfileLifecycleManagement
    Indicates whether idle shutdown is activated for the application type.
    max_idle_timeout_in_minutes int
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    min_idle_timeout_in_minutes int
    The minimum value in minutes that custom idle shutdown can be set to by the user.
    idleTimeoutInMinutes Number
    The time that SageMaker waits after the application becomes idle before shutting it down.
    lifecycleManagement "ENABLED" | "DISABLED"
    Indicates whether idle shutdown is activated for the application type.
    maxIdleTimeoutInMinutes Number
    The maximum value in minutes that custom idle shutdown can be set to by the user.
    minIdleTimeoutInMinutes Number
    The minimum value in minutes that custom idle shutdown can be set to by the user.

    UserProfileJupyterLabAppSettings

    AppLifecycleManagement Pulumi.AwsNative.SageMaker.Inputs.UserProfileAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    CodeRepositories List<Pulumi.AwsNative.SageMaker.Inputs.UserProfileCodeRepository>
    A list of CodeRepositories available for use with JupyterLab apps.
    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.UserProfileCustomImage>
    A list of custom images available for use for JupyterLab apps
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    LifecycleConfigArns List<string>
    A list of LifecycleConfigArns available for use with JupyterLab apps.
    AppLifecycleManagement UserProfileAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    CodeRepositories []UserProfileCodeRepository
    A list of CodeRepositories available for use with JupyterLab apps.
    CustomImages []UserProfileCustomImage
    A list of custom images available for use for JupyterLab apps
    DefaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    LifecycleConfigArns []string
    A list of LifecycleConfigArns available for use with JupyterLab apps.
    appLifecycleManagement UserProfileAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    codeRepositories List<UserProfileCodeRepository>
    A list of CodeRepositories available for use with JupyterLab apps.
    customImages List<UserProfileCustomImage>
    A list of custom images available for use for JupyterLab apps
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with JupyterLab apps.
    appLifecycleManagement UserProfileAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    codeRepositories UserProfileCodeRepository[]
    A list of CodeRepositories available for use with JupyterLab apps.
    customImages UserProfileCustomImage[]
    A list of custom images available for use for JupyterLab apps
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    lifecycleConfigArns string[]
    A list of LifecycleConfigArns available for use with JupyterLab apps.
    app_lifecycle_management UserProfileAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    code_repositories Sequence[UserProfileCodeRepository]
    A list of CodeRepositories available for use with JupyterLab apps.
    custom_images Sequence[UserProfileCustomImage]
    A list of custom images available for use for JupyterLab apps
    default_resource_spec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    lifecycle_config_arns Sequence[str]
    A list of LifecycleConfigArns available for use with JupyterLab apps.
    appLifecycleManagement Property Map
    Indicates whether idle shutdown is activated for JupyterLab applications.
    codeRepositories List<Property Map>
    A list of CodeRepositories available for use with JupyterLab apps.
    customImages List<Property Map>
    A list of custom images available for use for JupyterLab apps
    defaultResourceSpec Property Map
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with JupyterLab apps.

    UserProfileJupyterServerAppSettings

    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    LifecycleConfigArns List<string>
    A list of LifecycleConfigArns available for use with JupyterServer apps.
    DefaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    LifecycleConfigArns []string
    A list of LifecycleConfigArns available for use with JupyterServer apps.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with JupyterServer apps.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    lifecycleConfigArns string[]
    A list of LifecycleConfigArns available for use with JupyterServer apps.
    default_resource_spec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    lifecycle_config_arns Sequence[str]
    A list of LifecycleConfigArns available for use with JupyterServer apps.
    defaultResourceSpec Property Map
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with JupyterServer apps.

    UserProfileKernelGatewayAppSettings

    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.UserProfileCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    LifecycleConfigArns List<string>
    A list of LifecycleConfigArns available for use with KernelGateway apps.
    CustomImages []UserProfileCustomImage
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    LifecycleConfigArns []string
    A list of LifecycleConfigArns available for use with KernelGateway apps.
    customImages List<UserProfileCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with KernelGateway apps.
    customImages UserProfileCustomImage[]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    lifecycleConfigArns string[]
    A list of LifecycleConfigArns available for use with KernelGateway apps.
    custom_images Sequence[UserProfileCustomImage]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    default_resource_spec UserProfileResourceSpec
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    lifecycle_config_arns Sequence[str]
    A list of LifecycleConfigArns available for use with KernelGateway apps.
    customImages List<Property Map>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec Property Map
    The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
    lifecycleConfigArns List<String>
    A list of LifecycleConfigArns available for use with KernelGateway apps.

    UserProfileLifecycleManagement

    UserProfileMlTools

    UserProfileRStudioServerProAppSettings

    AccessStatus Pulumi.AwsNative.SageMaker.UserProfileRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    UserGroup Pulumi.AwsNative.SageMaker.UserProfileRStudioServerProAppSettingsUserGroup
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
    AccessStatus UserProfileRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    UserGroup UserProfileRStudioServerProAppSettingsUserGroup
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
    accessStatus UserProfileRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    userGroup UserProfileRStudioServerProAppSettingsUserGroup
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
    accessStatus UserProfileRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    userGroup UserProfileRStudioServerProAppSettingsUserGroup
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
    access_status UserProfileRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    user_group UserProfileRStudioServerProAppSettingsUserGroup
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
    accessStatus "ENABLED" | "DISABLED"
    Indicates whether the current user has access to the RStudioServerPro app.
    userGroup "R_STUDIO_ADMIN" | "R_STUDIO_USER"
    The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

    UserProfileRStudioServerProAppSettingsAccessStatus

    UserProfileRStudioServerProAppSettingsUserGroup

    UserProfileResourceSpec

    InstanceType Pulumi.AwsNative.SageMaker.UserProfileResourceSpecInstanceType
    The instance type that the image version runs on.
    LifecycleConfigArn string
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    SageMakerImageArn string
    The ARN of the SageMaker image that the image version belongs to.
    SageMakerImageVersionArn string
    The ARN of the image version created on the instance.
    InstanceType UserProfileResourceSpecInstanceType
    The instance type that the image version runs on.
    LifecycleConfigArn string
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    SageMakerImageArn string
    The ARN of the SageMaker image that the image version belongs to.
    SageMakerImageVersionArn string
    The ARN of the image version created on the instance.
    instanceType UserProfileResourceSpecInstanceType
    The instance type that the image version runs on.
    lifecycleConfigArn String
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    sageMakerImageArn String
    The ARN of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn String
    The ARN of the image version created on the instance.
    instanceType UserProfileResourceSpecInstanceType
    The instance type that the image version runs on.
    lifecycleConfigArn string
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    sageMakerImageArn string
    The ARN of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn string
    The ARN of the image version created on the instance.
    instance_type UserProfileResourceSpecInstanceType
    The instance type that the image version runs on.
    lifecycle_config_arn str
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    sage_maker_image_arn str
    The ARN of the SageMaker image that the image version belongs to.
    sage_maker_image_version_arn str
    The ARN of the image version created on the instance.
    instanceType "system" | "ml.t3.micro" | "ml.t3.small" | "ml.t3.medium" | "ml.t3.large" | "ml.t3.xlarge" | "ml.t3.2xlarge" | "ml.m5.large" | "ml.m5.xlarge" | "ml.m5.2xlarge" | "ml.m5.4xlarge" | "ml.m5.8xlarge" | "ml.m5.12xlarge" | "ml.m5.16xlarge" | "ml.m5.24xlarge" | "ml.c5.large" | "ml.c5.xlarge" | "ml.c5.2xlarge" | "ml.c5.4xlarge" | "ml.c5.9xlarge" | "ml.c5.12xlarge" | "ml.c5.18xlarge" | "ml.c5.24xlarge" | "ml.p3.2xlarge" | "ml.p3.8xlarge" | "ml.p3.16xlarge" | "ml.g4dn.xlarge" | "ml.g4dn.2xlarge" | "ml.g4dn.4xlarge" | "ml.g4dn.8xlarge" | "ml.g4dn.12xlarge" | "ml.g4dn.16xlarge" | "ml.r5.large" | "ml.r5.xlarge" | "ml.r5.2xlarge" | "ml.r5.4xlarge" | "ml.r5.8xlarge" | "ml.r5.12xlarge" | "ml.r5.16xlarge" | "ml.r5.24xlarge" | "ml.p3dn.24xlarge" | "ml.m5d.large" | "ml.m5d.xlarge" | "ml.m5d.2xlarge" | "ml.m5d.4xlarge" | "ml.m5d.8xlarge" | "ml.m5d.12xlarge" | "ml.m5d.16xlarge" | "ml.m5d.24xlarge" | "ml.g5.xlarge" | "ml.g5.2xlarge" | "ml.g5.4xlarge" | "ml.g5.8xlarge" | "ml.g5.12xlarge" | "ml.g5.16xlarge" | "ml.g5.24xlarge" | "ml.g5.48xlarge" | "ml.p4d.24xlarge" | "ml.p4de.24xlarge" | "ml.geospatial.interactive" | "ml.trn1.2xlarge" | "ml.trn1.32xlarge" | "ml.trn1n.32xlarge"
    The instance type that the image version runs on.
    lifecycleConfigArn String
    The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.
    sageMakerImageArn String
    The ARN of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn String
    The ARN of the image version created on the instance.

    UserProfileResourceSpecInstanceType

    UserProfileSharingSettings

    NotebookOutputOption Pulumi.AwsNative.SageMaker.UserProfileSharingSettingsNotebookOutputOption
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    S3KmsKeyId string
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    S3OutputPath string
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
    NotebookOutputOption UserProfileSharingSettingsNotebookOutputOption
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    S3KmsKeyId string
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    S3OutputPath string
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
    notebookOutputOption UserProfileSharingSettingsNotebookOutputOption
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    s3KmsKeyId String
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    s3OutputPath String
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
    notebookOutputOption UserProfileSharingSettingsNotebookOutputOption
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    s3KmsKeyId string
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    s3OutputPath string
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
    notebook_output_option UserProfileSharingSettingsNotebookOutputOption
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    s3_kms_key_id str
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    s3_output_path str
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.
    notebookOutputOption "Allowed" | "Disabled"
    Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
    s3KmsKeyId String
    When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
    s3OutputPath String
    When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

    UserProfileSharingSettingsNotebookOutputOption

    UserProfileStudioWebPortalSettings

    HiddenAppTypes List<Pulumi.AwsNative.SageMaker.UserProfileAppType>
    Applications supported in Studio that are hidden from the Studio left navigation pane.
    HiddenMlTools List<Pulumi.AwsNative.SageMaker.UserProfileMlTools>
    The machine learning tools that are hidden from the Studio left navigation pane.
    HiddenAppTypes []UserProfileAppType
    Applications supported in Studio that are hidden from the Studio left navigation pane.
    HiddenMlTools []UserProfileMlTools
    The machine learning tools that are hidden from the Studio left navigation pane.
    hiddenAppTypes List<UserProfileAppType>
    Applications supported in Studio that are hidden from the Studio left navigation pane.
    hiddenMlTools List<UserProfileMlTools>
    The machine learning tools that are hidden from the Studio left navigation pane.
    hiddenAppTypes UserProfileAppType[]
    Applications supported in Studio that are hidden from the Studio left navigation pane.
    hiddenMlTools UserProfileMlTools[]
    The machine learning tools that are hidden from the Studio left navigation pane.
    hidden_app_types Sequence[UserProfileAppType]
    Applications supported in Studio that are hidden from the Studio left navigation pane.
    hidden_ml_tools Sequence[UserProfileMlTools]
    The machine learning tools that are hidden from the Studio left navigation pane.

    UserProfileUserSettings

    CodeEditorAppSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileCodeEditorAppSettings

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    CustomFileSystemConfigs List<Pulumi.AwsNative.SageMaker.Inputs.UserProfileCustomFileSystemConfig>

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    CustomPosixUserConfig Pulumi.AwsNative.SageMaker.Inputs.UserProfileCustomPosixUserConfig

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    DefaultLandingUri string
    Defines which Amazon SageMaker application users are directed to by default.
    ExecutionRole string
    The user profile Amazon Resource Name (ARN).
    JupyterLabAppSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileJupyterLabAppSettings

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    JupyterServerAppSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileKernelGatewayAppSettings
    The kernel gateway app settings.
    RStudioServerProAppSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileRStudioServerProAppSettings
    A collection of settings that configure user interaction with the RStudioServerPro app.
    SecurityGroups List<string>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    SharingSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileSharingSettings
    The sharing settings.
    SpaceStorageSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileDefaultSpaceStorageSettings

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    StudioWebPortal Pulumi.AwsNative.SageMaker.UserProfileUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    StudioWebPortalSettings Pulumi.AwsNative.SageMaker.Inputs.UserProfileStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    CodeEditorAppSettings UserProfileCodeEditorAppSettings

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    CustomFileSystemConfigs []UserProfileCustomFileSystemConfig

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    CustomPosixUserConfig UserProfileCustomPosixUserConfig

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    DefaultLandingUri string
    Defines which Amazon SageMaker application users are directed to by default.
    ExecutionRole string
    The user profile Amazon Resource Name (ARN).
    JupyterLabAppSettings UserProfileJupyterLabAppSettings

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    JupyterServerAppSettings UserProfileJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings UserProfileKernelGatewayAppSettings
    The kernel gateway app settings.
    RStudioServerProAppSettings UserProfileRStudioServerProAppSettings
    A collection of settings that configure user interaction with the RStudioServerPro app.
    SecurityGroups []string
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    SharingSettings UserProfileSharingSettings
    The sharing settings.
    SpaceStorageSettings UserProfileDefaultSpaceStorageSettings

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    StudioWebPortal UserProfileUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    StudioWebPortalSettings UserProfileStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    codeEditorAppSettings UserProfileCodeEditorAppSettings

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customFileSystemConfigs List<UserProfileCustomFileSystemConfig>

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customPosixUserConfig UserProfileCustomPosixUserConfig

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    defaultLandingUri String
    Defines which Amazon SageMaker application users are directed to by default.
    executionRole String
    The user profile Amazon Resource Name (ARN).
    jupyterLabAppSettings UserProfileJupyterLabAppSettings

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    jupyterServerAppSettings UserProfileJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings UserProfileKernelGatewayAppSettings
    The kernel gateway app settings.
    rStudioServerProAppSettings UserProfileRStudioServerProAppSettings
    A collection of settings that configure user interaction with the RStudioServerPro app.
    securityGroups List<String>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    sharingSettings UserProfileSharingSettings
    The sharing settings.
    spaceStorageSettings UserProfileDefaultSpaceStorageSettings

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    studioWebPortal UserProfileUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studioWebPortalSettings UserProfileStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    codeEditorAppSettings UserProfileCodeEditorAppSettings

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customFileSystemConfigs UserProfileCustomFileSystemConfig[]

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customPosixUserConfig UserProfileCustomPosixUserConfig

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    defaultLandingUri string
    Defines which Amazon SageMaker application users are directed to by default.
    executionRole string
    The user profile Amazon Resource Name (ARN).
    jupyterLabAppSettings UserProfileJupyterLabAppSettings

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    jupyterServerAppSettings UserProfileJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings UserProfileKernelGatewayAppSettings
    The kernel gateway app settings.
    rStudioServerProAppSettings UserProfileRStudioServerProAppSettings
    A collection of settings that configure user interaction with the RStudioServerPro app.
    securityGroups string[]
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    sharingSettings UserProfileSharingSettings
    The sharing settings.
    spaceStorageSettings UserProfileDefaultSpaceStorageSettings

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    studioWebPortal UserProfileUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studioWebPortalSettings UserProfileStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    code_editor_app_settings UserProfileCodeEditorAppSettings

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    custom_file_system_configs Sequence[UserProfileCustomFileSystemConfig]

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    custom_posix_user_config UserProfileCustomPosixUserConfig

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    default_landing_uri str
    Defines which Amazon SageMaker application users are directed to by default.
    execution_role str
    The user profile Amazon Resource Name (ARN).
    jupyter_lab_app_settings UserProfileJupyterLabAppSettings

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    jupyter_server_app_settings UserProfileJupyterServerAppSettings
    The Jupyter server's app settings.
    kernel_gateway_app_settings UserProfileKernelGatewayAppSettings
    The kernel gateway app settings.
    r_studio_server_pro_app_settings UserProfileRStudioServerProAppSettings
    A collection of settings that configure user interaction with the RStudioServerPro app.
    security_groups Sequence[str]
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    sharing_settings UserProfileSharingSettings
    The sharing settings.
    space_storage_settings UserProfileDefaultSpaceStorageSettings

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    studio_web_portal UserProfileUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studio_web_portal_settings UserProfileStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    codeEditorAppSettings Property Map

    The Code Editor application settings.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customFileSystemConfigs List<Property Map>

    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    customPosixUserConfig Property Map

    Details about the POSIX identity that is used for file system operations.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    defaultLandingUri String
    Defines which Amazon SageMaker application users are directed to by default.
    executionRole String
    The user profile Amazon Resource Name (ARN).
    jupyterLabAppSettings Property Map

    The settings for the JupyterLab application.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    jupyterServerAppSettings Property Map
    The Jupyter server's app settings.
    kernelGatewayAppSettings Property Map
    The kernel gateway app settings.
    rStudioServerProAppSettings Property Map
    A collection of settings that configure user interaction with the RStudioServerPro app.
    securityGroups List<String>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    sharingSettings Property Map
    The sharing settings.
    spaceStorageSettings Property Map

    The storage settings for a space.

    SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    studioWebPortal "ENABLED" | "DISABLED"
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studioWebPortalSettings Property Map
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

    UserProfileUserSettingsStudioWebPortal

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native