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

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.getDomain

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::Domain

    Using getDomain

    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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
    def get_domain(domain_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
    func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

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

    public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    DomainId string
    The domain name.
    DomainId string
    The domain name.
    domainId String
    The domain name.
    domainId string
    The domain name.
    domain_id str
    The domain name.
    domainId String
    The domain name.

    getDomain Result

    The following output properties are available:

    AppNetworkAccessType Pulumi.AwsNative.SageMaker.DomainAppNetworkAccessType
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    AppSecurityGroupManagement Pulumi.AwsNative.SageMaker.DomainAppSecurityGroupManagement
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    DefaultSpaceSettings Pulumi.AwsNative.SageMaker.Outputs.DomainDefaultSpaceSettings
    The default space settings.
    DefaultUserSettings Pulumi.AwsNative.SageMaker.Outputs.DomainUserSettings
    The default user settings.
    DomainArn string
    The Amazon Resource Name (ARN) of the created domain.
    DomainId string
    The domain name.
    DomainSettings Pulumi.AwsNative.SageMaker.Outputs.DomainSettings
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    HomeEfsFileSystemId string
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    SecurityGroupIdForDomainBoundary string
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    SingleSignOnApplicationArn string
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    SingleSignOnManagedApplicationInstanceId string
    The SSO managed application instance ID.
    SubnetIds List<string>
    The VPC subnets that Studio uses for communication.
    TagPropagation Pulumi.AwsNative.SageMaker.DomainTagPropagation
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    Url string
    The URL to the created domain.
    AppNetworkAccessType DomainAppNetworkAccessType
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    AppSecurityGroupManagement DomainAppSecurityGroupManagement
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    DefaultSpaceSettings DomainDefaultSpaceSettings
    The default space settings.
    DefaultUserSettings DomainUserSettings
    The default user settings.
    DomainArn string
    The Amazon Resource Name (ARN) of the created domain.
    DomainId string
    The domain name.
    DomainSettings DomainSettings
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    HomeEfsFileSystemId string
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    SecurityGroupIdForDomainBoundary string
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    SingleSignOnApplicationArn string
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    SingleSignOnManagedApplicationInstanceId string
    The SSO managed application instance ID.
    SubnetIds []string
    The VPC subnets that Studio uses for communication.
    TagPropagation DomainTagPropagation
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    Url string
    The URL to the created domain.
    appNetworkAccessType DomainAppNetworkAccessType
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    appSecurityGroupManagement DomainAppSecurityGroupManagement
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    defaultSpaceSettings DomainDefaultSpaceSettings
    The default space settings.
    defaultUserSettings DomainUserSettings
    The default user settings.
    domainArn String
    The Amazon Resource Name (ARN) of the created domain.
    domainId String
    The domain name.
    domainSettings DomainSettings
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    homeEfsFileSystemId String
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    securityGroupIdForDomainBoundary String
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    singleSignOnApplicationArn String
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    singleSignOnManagedApplicationInstanceId String
    The SSO managed application instance ID.
    subnetIds List<String>
    The VPC subnets that Studio uses for communication.
    tagPropagation DomainTagPropagation
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    url String
    The URL to the created domain.
    appNetworkAccessType DomainAppNetworkAccessType
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    appSecurityGroupManagement DomainAppSecurityGroupManagement
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    defaultSpaceSettings DomainDefaultSpaceSettings
    The default space settings.
    defaultUserSettings DomainUserSettings
    The default user settings.
    domainArn string
    The Amazon Resource Name (ARN) of the created domain.
    domainId string
    The domain name.
    domainSettings DomainSettings
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    homeEfsFileSystemId string
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    securityGroupIdForDomainBoundary string
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    singleSignOnApplicationArn string
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    singleSignOnManagedApplicationInstanceId string
    The SSO managed application instance ID.
    subnetIds string[]
    The VPC subnets that Studio uses for communication.
    tagPropagation DomainTagPropagation
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    url string
    The URL to the created domain.
    app_network_access_type DomainAppNetworkAccessType
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    app_security_group_management DomainAppSecurityGroupManagement
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    default_space_settings DomainDefaultSpaceSettings
    The default space settings.
    default_user_settings DomainUserSettings
    The default user settings.
    domain_arn str
    The Amazon Resource Name (ARN) of the created domain.
    domain_id str
    The domain name.
    domain_settings DomainSettings
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    home_efs_file_system_id str
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    security_group_id_for_domain_boundary str
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    single_sign_on_application_arn str
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    single_sign_on_managed_application_instance_id str
    The SSO managed application instance ID.
    subnet_ids Sequence[str]
    The VPC subnets that Studio uses for communication.
    tag_propagation DomainTagPropagation
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    url str
    The URL to the created domain.
    appNetworkAccessType "PublicInternetOnly" | "VpcOnly"
    Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.
    appSecurityGroupManagement "Service" | "Customer"
    The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
    defaultSpaceSettings Property Map
    The default space settings.
    defaultUserSettings Property Map
    The default user settings.
    domainArn String
    The Amazon Resource Name (ARN) of the created domain.
    domainId String
    The domain name.
    domainSettings Property Map
    A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.
    homeEfsFileSystemId String
    The ID of the Amazon Elastic File System (EFS) managed by this Domain.
    securityGroupIdForDomainBoundary String
    The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
    singleSignOnApplicationArn String
    The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
    singleSignOnManagedApplicationInstanceId String
    The SSO managed application instance ID.
    subnetIds List<String>
    The VPC subnets that Studio uses for communication.
    tagPropagation "ENABLED" | "DISABLED"
    Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
    url String
    The URL to the created domain.

    Supporting Types

    DomainAppLifecycleManagement

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

    DomainAppNetworkAccessType

    DomainAppSecurityGroupManagement

    DomainAppType

    DomainCodeEditorAppSettings

    AppLifecycleManagement Pulumi.AwsNative.SageMaker.Inputs.DomainAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomImage>
    A list of custom images for use for CodeEditor apps.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    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 DomainAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    CustomImages []DomainCustomImage
    A list of custom images for use for CodeEditor apps.
    DefaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    customImages List<DomainCustomImage>
    A list of custom images for use for CodeEditor apps.
    defaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    customImages DomainCustomImage[]
    A list of custom images for use for CodeEditor apps.
    defaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Settings that are used to configure and manage the lifecycle of CodeEditor applications.
    custom_images Sequence[DomainCustomImage]
    A list of custom images for use for CodeEditor apps.
    default_resource_spec DomainResourceSpec
    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.

    DomainCodeRepository

    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.

    DomainCustomFileSystemConfig

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

    DomainCustomImage

    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.

    DomainCustomPosixUserConfig

    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.

    DomainDefaultEbsStorageSettings

    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.

    DomainDefaultSpaceSettings

    ExecutionRole string
    The execution role for the space.
    CustomFileSystemConfigs List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomFileSystemConfig>
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    CustomPosixUserConfig Pulumi.AwsNative.SageMaker.Inputs.DomainCustomPosixUserConfig
    The Jupyter lab's custom posix user configurations.
    JupyterLabAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainJupyterLabAppSettings
    The Jupyter lab's app settings.
    JupyterServerAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    SecurityGroups List<string>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    SpaceStorageSettings Pulumi.AwsNative.SageMaker.Inputs.DomainDefaultSpaceStorageSettings
    The Jupyter lab's space storage settings.
    ExecutionRole string
    The execution role for the space.
    CustomFileSystemConfigs []DomainCustomFileSystemConfig
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    CustomPosixUserConfig DomainCustomPosixUserConfig
    The Jupyter lab's custom posix user configurations.
    JupyterLabAppSettings DomainJupyterLabAppSettings
    The Jupyter lab's app settings.
    JupyterServerAppSettings DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    SecurityGroups []string
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    SpaceStorageSettings DomainDefaultSpaceStorageSettings
    The Jupyter lab's space storage settings.
    executionRole String
    The execution role for the space.
    customFileSystemConfigs List<DomainCustomFileSystemConfig>
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    customPosixUserConfig DomainCustomPosixUserConfig
    The Jupyter lab's custom posix user configurations.
    jupyterLabAppSettings DomainJupyterLabAppSettings
    The Jupyter lab's app settings.
    jupyterServerAppSettings DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    securityGroups List<String>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    spaceStorageSettings DomainDefaultSpaceStorageSettings
    The Jupyter lab's space storage settings.
    executionRole string
    The execution role for the space.
    customFileSystemConfigs DomainCustomFileSystemConfig[]
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    customPosixUserConfig DomainCustomPosixUserConfig
    The Jupyter lab's custom posix user configurations.
    jupyterLabAppSettings DomainJupyterLabAppSettings
    The Jupyter lab's app settings.
    jupyterServerAppSettings DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    securityGroups string[]
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    spaceStorageSettings DomainDefaultSpaceStorageSettings
    The Jupyter lab's space storage settings.
    execution_role str
    The execution role for the space.
    custom_file_system_configs Sequence[DomainCustomFileSystemConfig]
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    custom_posix_user_config DomainCustomPosixUserConfig
    The Jupyter lab's custom posix user configurations.
    jupyter_lab_app_settings DomainJupyterLabAppSettings
    The Jupyter lab's app settings.
    jupyter_server_app_settings DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernel_gateway_app_settings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    security_groups Sequence[str]
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    space_storage_settings DomainDefaultSpaceStorageSettings
    The Jupyter lab's space storage settings.
    executionRole String
    The execution role for the space.
    customFileSystemConfigs List<Property Map>
    The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
    customPosixUserConfig Property Map
    The Jupyter lab's custom posix user configurations.
    jupyterLabAppSettings Property Map
    The Jupyter lab's app settings.
    jupyterServerAppSettings Property Map
    The Jupyter server's app settings.
    kernelGatewayAppSettings Property Map
    The kernel gateway app settings.
    securityGroups List<String>
    The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
    spaceStorageSettings Property Map
    The Jupyter lab's space storage settings.

    DomainDefaultSpaceStorageSettings

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

    DomainDockerSettings

    EnableDockerAccess Pulumi.AwsNative.SageMaker.DomainDockerSettingsEnableDockerAccess
    The flag to enable/disable docker-proxy server
    VpcOnlyTrustedAccounts List<string>
    A list of account id's that would be used to pull images from in VpcOnly mode
    EnableDockerAccess DomainDockerSettingsEnableDockerAccess
    The flag to enable/disable docker-proxy server
    VpcOnlyTrustedAccounts []string
    A list of account id's that would be used to pull images from in VpcOnly mode
    enableDockerAccess DomainDockerSettingsEnableDockerAccess
    The flag to enable/disable docker-proxy server
    vpcOnlyTrustedAccounts List<String>
    A list of account id's that would be used to pull images from in VpcOnly mode
    enableDockerAccess DomainDockerSettingsEnableDockerAccess
    The flag to enable/disable docker-proxy server
    vpcOnlyTrustedAccounts string[]
    A list of account id's that would be used to pull images from in VpcOnly mode
    enable_docker_access DomainDockerSettingsEnableDockerAccess
    The flag to enable/disable docker-proxy server
    vpc_only_trusted_accounts Sequence[str]
    A list of account id's that would be used to pull images from in VpcOnly mode
    enableDockerAccess "ENABLED" | "DISABLED"
    The flag to enable/disable docker-proxy server
    vpcOnlyTrustedAccounts List<String>
    A list of account id's that would be used to pull images from in VpcOnly mode

    DomainDockerSettingsEnableDockerAccess

    DomainEfsFileSystemConfig

    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.

    DomainIdleSettings

    IdleTimeoutInMinutes int
    The time that SageMaker waits after the application becomes idle before shutting it down.
    LifecycleManagement Pulumi.AwsNative.SageMaker.DomainLifecycleManagement
    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 DomainLifecycleManagement
    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 DomainLifecycleManagement
    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 DomainLifecycleManagement
    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 DomainLifecycleManagement
    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.

    DomainJupyterLabAppSettings

    AppLifecycleManagement Pulumi.AwsNative.SageMaker.Inputs.DomainAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    CodeRepositories List<Pulumi.AwsNative.SageMaker.Inputs.DomainCodeRepository>
    A list of CodeRepositories available for use with JupyterLab apps.
    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomImage>
    A list of custom images for use for JupyterLab apps.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    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 DomainAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    CodeRepositories []DomainCodeRepository
    A list of CodeRepositories available for use with JupyterLab apps.
    CustomImages []DomainCustomImage
    A list of custom images for use for JupyterLab apps.
    DefaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    codeRepositories List<DomainCodeRepository>
    A list of CodeRepositories available for use with JupyterLab apps.
    customImages List<DomainCustomImage>
    A list of custom images for use for JupyterLab apps.
    defaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    codeRepositories DomainCodeRepository[]
    A list of CodeRepositories available for use with JupyterLab apps.
    customImages DomainCustomImage[]
    A list of custom images for use for JupyterLab apps.
    defaultResourceSpec DomainResourceSpec
    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 DomainAppLifecycleManagement
    Indicates whether idle shutdown is activated for JupyterLab applications.
    code_repositories Sequence[DomainCodeRepository]
    A list of CodeRepositories available for use with JupyterLab apps.
    custom_images Sequence[DomainCustomImage]
    A list of custom images for use for JupyterLab apps.
    default_resource_spec DomainResourceSpec
    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 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.

    DomainJupyterServerAppSettings

    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    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 DomainResourceSpec
    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 DomainResourceSpec
    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 DomainResourceSpec
    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 DomainResourceSpec
    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.

    DomainKernelGatewayAppSettings

    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    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 []DomainCustomImage
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec DomainResourceSpec
    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<DomainCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec DomainResourceSpec
    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 DomainCustomImage[]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec DomainResourceSpec
    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[DomainCustomImage]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    default_resource_spec DomainResourceSpec
    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.

    DomainLifecycleManagement

    DomainMlTools

    DomainRSessionAppSettings

    CustomImages List<Pulumi.AwsNative.SageMaker.Inputs.DomainCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    CustomImages []DomainCustomImage
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    DefaultResourceSpec DomainResourceSpec
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    customImages List<DomainCustomImage>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec DomainResourceSpec
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    customImages DomainCustomImage[]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec DomainResourceSpec
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    custom_images Sequence[DomainCustomImage]
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    default_resource_spec DomainResourceSpec
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
    customImages List<Property Map>
    A list of custom SageMaker images that are configured to run as a KernelGateway app.
    defaultResourceSpec Property Map
    Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

    DomainRStudioServerProAppSettings

    AccessStatus Pulumi.AwsNative.SageMaker.DomainRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    UserGroup Pulumi.AwsNative.SageMaker.DomainRStudioServerProAppSettingsUserGroup
    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 DomainRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    UserGroup DomainRStudioServerProAppSettingsUserGroup
    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 DomainRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    userGroup DomainRStudioServerProAppSettingsUserGroup
    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 DomainRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    userGroup DomainRStudioServerProAppSettingsUserGroup
    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 DomainRStudioServerProAppSettingsAccessStatus
    Indicates whether the current user has access to the RStudioServerPro app.
    user_group DomainRStudioServerProAppSettingsUserGroup
    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.

    DomainRStudioServerProAppSettingsAccessStatus

    DomainRStudioServerProAppSettingsUserGroup

    DomainRStudioServerProDomainSettings

    DomainExecutionRoleArn string
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    DefaultResourceSpec Pulumi.AwsNative.SageMaker.Inputs.DomainResourceSpec
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    RStudioConnectUrl string
    A URL pointing to an RStudio Connect server.
    RStudioPackageManagerUrl string
    A URL pointing to an RStudio Package Manager server.
    DomainExecutionRoleArn string
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    DefaultResourceSpec DomainResourceSpec
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    RStudioConnectUrl string
    A URL pointing to an RStudio Connect server.
    RStudioPackageManagerUrl string
    A URL pointing to an RStudio Package Manager server.
    domainExecutionRoleArn String
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    defaultResourceSpec DomainResourceSpec
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    rStudioConnectUrl String
    A URL pointing to an RStudio Connect server.
    rStudioPackageManagerUrl String
    A URL pointing to an RStudio Package Manager server.
    domainExecutionRoleArn string
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    defaultResourceSpec DomainResourceSpec
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    rStudioConnectUrl string
    A URL pointing to an RStudio Connect server.
    rStudioPackageManagerUrl string
    A URL pointing to an RStudio Package Manager server.
    domain_execution_role_arn str
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    default_resource_spec DomainResourceSpec
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    r_studio_connect_url str
    A URL pointing to an RStudio Connect server.
    r_studio_package_manager_url str
    A URL pointing to an RStudio Package Manager server.
    domainExecutionRoleArn String
    The ARN of the execution role for the RStudioServerPro Domain-level app.
    defaultResourceSpec Property Map
    A collection that defines the default InstanceType , SageMakerImageArn , and SageMakerImageVersionArn for the Domain.
    rStudioConnectUrl String
    A URL pointing to an RStudio Connect server.
    rStudioPackageManagerUrl String
    A URL pointing to an RStudio Package Manager server.

    DomainResourceSpec

    InstanceType Pulumi.AwsNative.SageMaker.DomainResourceSpecInstanceType
    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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    SageMakerImageVersionArn string
    The Amazon Resource Name (ARN) of the image version created on the instance.
    InstanceType DomainResourceSpecInstanceType
    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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    SageMakerImageVersionArn string
    The Amazon Resource Name (ARN) of the image version created on the instance.
    instanceType DomainResourceSpecInstanceType
    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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn String
    The Amazon Resource Name (ARN) of the image version created on the instance.
    instanceType DomainResourceSpecInstanceType
    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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn string
    The Amazon Resource Name (ARN) of the image version created on the instance.
    instance_type DomainResourceSpecInstanceType
    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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    sage_maker_image_version_arn str
    The Amazon Resource Name (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 Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.
    sageMakerImageVersionArn String
    The Amazon Resource Name (ARN) of the image version created on the instance.

    DomainResourceSpecInstanceType

    DomainSettings

    DockerSettings Pulumi.AwsNative.SageMaker.Inputs.DomainDockerSettings
    A collection of settings that configure the domain's Docker interaction.
    ExecutionRoleIdentityConfig Pulumi.AwsNative.SageMaker.DomainSettingsExecutionRoleIdentityConfig
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    RStudioServerProDomainSettings Pulumi.AwsNative.SageMaker.Inputs.DomainRStudioServerProDomainSettings
    A collection of settings that configure the RStudioServerPro Domain-level app.
    SecurityGroupIds List<string>
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    DockerSettings DomainDockerSettings
    A collection of settings that configure the domain's Docker interaction.
    ExecutionRoleIdentityConfig DomainSettingsExecutionRoleIdentityConfig
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    RStudioServerProDomainSettings DomainRStudioServerProDomainSettings
    A collection of settings that configure the RStudioServerPro Domain-level app.
    SecurityGroupIds []string
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    dockerSettings DomainDockerSettings
    A collection of settings that configure the domain's Docker interaction.
    executionRoleIdentityConfig DomainSettingsExecutionRoleIdentityConfig
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    rStudioServerProDomainSettings DomainRStudioServerProDomainSettings
    A collection of settings that configure the RStudioServerPro Domain-level app.
    securityGroupIds List<String>
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    dockerSettings DomainDockerSettings
    A collection of settings that configure the domain's Docker interaction.
    executionRoleIdentityConfig DomainSettingsExecutionRoleIdentityConfig
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    rStudioServerProDomainSettings DomainRStudioServerProDomainSettings
    A collection of settings that configure the RStudioServerPro Domain-level app.
    securityGroupIds string[]
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    docker_settings DomainDockerSettings
    A collection of settings that configure the domain's Docker interaction.
    execution_role_identity_config DomainSettingsExecutionRoleIdentityConfig
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    r_studio_server_pro_domain_settings DomainRStudioServerProDomainSettings
    A collection of settings that configure the RStudioServerPro Domain-level app.
    security_group_ids Sequence[str]
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
    dockerSettings Property Map
    A collection of settings that configure the domain's Docker interaction.
    executionRoleIdentityConfig "USER_PROFILE_NAME" | "DISABLED"
    The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
    rStudioServerProDomainSettings Property Map
    A collection of settings that configure the RStudioServerPro Domain-level app.
    securityGroupIds List<String>
    The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

    DomainSettingsExecutionRoleIdentityConfig

    DomainSharingSettings

    NotebookOutputOption Pulumi.AwsNative.SageMaker.DomainSharingSettingsNotebookOutputOption
    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 DomainSharingSettingsNotebookOutputOption
    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 DomainSharingSettingsNotebookOutputOption
    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 DomainSharingSettingsNotebookOutputOption
    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 DomainSharingSettingsNotebookOutputOption
    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.

    DomainSharingSettingsNotebookOutputOption

    DomainStudioWebPortalSettings

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

    DomainTagPropagation

    DomainUserSettings

    ExecutionRole string
    The execution role for the user.
    CodeEditorAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainCodeEditorAppSettings

    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.DomainCustomFileSystemConfig>

    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.DomainCustomPosixUserConfig

    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.
    JupyterLabAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainJupyterLabAppSettings

    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.DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    RSessionAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainRSessionAppSettings
    A collection of settings that configure the RSessionGateway app.
    RStudioServerProAppSettings Pulumi.AwsNative.SageMaker.Inputs.DomainRStudioServerProAppSettings
    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.DomainSharingSettings
    The sharing settings.
    SpaceStorageSettings Pulumi.AwsNative.SageMaker.Inputs.DomainDefaultSpaceStorageSettings

    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.DomainUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    StudioWebPortalSettings Pulumi.AwsNative.SageMaker.Inputs.DomainStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    ExecutionRole string
    The execution role for the user.
    CodeEditorAppSettings DomainCodeEditorAppSettings

    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 []DomainCustomFileSystemConfig

    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 DomainCustomPosixUserConfig

    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.
    JupyterLabAppSettings DomainJupyterLabAppSettings

    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 DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    KernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    RSessionAppSettings DomainRSessionAppSettings
    A collection of settings that configure the RSessionGateway app.
    RStudioServerProAppSettings DomainRStudioServerProAppSettings
    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 DomainSharingSettings
    The sharing settings.
    SpaceStorageSettings DomainDefaultSpaceStorageSettings

    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 DomainUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    StudioWebPortalSettings DomainStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    executionRole String
    The execution role for the user.
    codeEditorAppSettings DomainCodeEditorAppSettings

    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<DomainCustomFileSystemConfig>

    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 DomainCustomPosixUserConfig

    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.
    jupyterLabAppSettings DomainJupyterLabAppSettings

    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 DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    rSessionAppSettings DomainRSessionAppSettings
    A collection of settings that configure the RSessionGateway app.
    rStudioServerProAppSettings DomainRStudioServerProAppSettings
    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 DomainSharingSettings
    The sharing settings.
    spaceStorageSettings DomainDefaultSpaceStorageSettings

    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 DomainUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studioWebPortalSettings DomainStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    executionRole string
    The execution role for the user.
    codeEditorAppSettings DomainCodeEditorAppSettings

    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 DomainCustomFileSystemConfig[]

    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 DomainCustomPosixUserConfig

    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.
    jupyterLabAppSettings DomainJupyterLabAppSettings

    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 DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernelGatewayAppSettings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    rSessionAppSettings DomainRSessionAppSettings
    A collection of settings that configure the RSessionGateway app.
    rStudioServerProAppSettings DomainRStudioServerProAppSettings
    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 DomainSharingSettings
    The sharing settings.
    spaceStorageSettings DomainDefaultSpaceStorageSettings

    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 DomainUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studioWebPortalSettings DomainStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    execution_role str
    The execution role for the user.
    code_editor_app_settings DomainCodeEditorAppSettings

    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[DomainCustomFileSystemConfig]

    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 DomainCustomPosixUserConfig

    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.
    jupyter_lab_app_settings DomainJupyterLabAppSettings

    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 DomainJupyterServerAppSettings
    The Jupyter server's app settings.
    kernel_gateway_app_settings DomainKernelGatewayAppSettings
    The kernel gateway app settings.
    r_session_app_settings DomainRSessionAppSettings
    A collection of settings that configure the RSessionGateway app.
    r_studio_server_pro_app_settings DomainRStudioServerProAppSettings
    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 DomainSharingSettings
    The sharing settings.
    space_storage_settings DomainDefaultSpaceStorageSettings

    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 DomainUserSettingsStudioWebPortal
    Indicates whether the Studio experience is available to users. If not, users cannot access Studio.
    studio_web_portal_settings DomainStudioWebPortalSettings
    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
    executionRole String
    The execution role for the user.
    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.
    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.
    rSessionAppSettings Property Map
    A collection of settings that configure the RSessionGateway app.
    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.

    DomainUserSettingsStudioWebPortal

    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