@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-sagemaker-domain.d.ts

@@ -0,0 +1,723 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerDomain = ResourceDefinitionWithAttributes<"AWS::SageMaker::Domain", SageMakerDomainProps, SageMakerDomainAttribs>;
+/**
+ * Creates a `Domain` . A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.
+ *
+ * *EFS storage*
+ *
+ * When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
+ *
+ * SageMaker AI uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see [Protect Data at Rest Using Encryption](https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) .
+ *
+ * *VPC configuration*
+ *
+ * All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds to the network access type that you choose when you onboard to the domain. The following options are available:
+ *
+ * - `PublicInternetOnly` - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.
+ * - `VpcOnly` - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
+ *
+ * When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.
+ *
+ * > NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.
+ *
+ * For more information, see [Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .
+ */
+export type SageMakerDomainProps = {
+    /**
+     * Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly` .
+     *
+     * - `PublicInternetOnly` - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI , which allows direct internet access
+     * - `VpcOnly` - All Studio traffic is through the specified VPC and subnets
+     *
+     * *Valid Values* : `PublicInternetOnly | VpcOnly`
+     */
+    AppNetworkAccessType?: "PublicInternetOnly" | "VpcOnly" | undefined;
+    /**
+     * 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. If setting up the domain for use with RStudio, this value must be set to `Service` .
+     *
+     * *Allowed Values* : `Service` | `Customer`
+     */
+    AppSecurityGroupManagement?: "Service" | "Customer" | undefined;
+    /**
+     * The mode of authentication that members use to access the Domain.
+     *
+     * *Valid Values* : `SSO | IAM`
+     */
+    AuthMode: "SSO" | "IAM";
+    /**
+     * The default settings for shared spaces that users create in the domain.
+     *
+     * SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
+     */
+    DefaultSpaceSettings?: DefaultSpaceSettings | undefined;
+    /**
+     * The default user settings.
+     */
+    DefaultUserSettings: UserSettings;
+    /**
+     * The domain name.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
+     */
+    DomainName: string;
+    /**
+     * A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the `CreateDomain` API call.
+     */
+    DomainSettings?: DomainSettings | undefined;
+    /**
+     * SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK.
+     *
+     * *Length Constraints* : Maximum length of 2048.
+     *
+     * *Pattern* : `.*`
+     * @maxLength 2048
+     * @pattern .*
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The VPC subnets that Studio uses for communication.
+     *
+     * *Length Constraints* : Maximum length of 32.
+     *
+     * *Array members* : Minimum number of 1 item. Maximum number of 16 items.
+     *
+     * *Pattern* : `[-0-9a-zA-Z]+`
+     */
+    SubnetIds: string[];
+    /**
+     * Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
+     */
+    TagPropagation?: "ENABLED" | "DISABLED" | undefined;
+    /**
+     * Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
+     *
+     * Tags that you specify for the Domain are also added to all apps that are launched in the Domain.
+     *
+     * *Array members* : Minimum number of 0 items. Maximum number of 50 items.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.
+     *
+     * *Length Constraints* : Maximum length of 32.
+     *
+     * *Pattern* : `[-0-9a-zA-Z]+`
+     * @maxLength 32
+     * @pattern [-0-9a-zA-Z]+
+     */
+    VpcId: string;
+};
+export type SageMakerDomainAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the Domain, such as `arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name` .
+     * @maxLength 256
+     * @pattern arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:domain/.*
+     */
+    DomainArn: string;
+    /**
+     * The Domain ID.
+     * @maxLength 63
+     * @pattern ^d-(-*[a-z0-9])+
+     */
+    DomainId: string;
+    /**
+     * The ID of the Amazon Elastic File System (EFS) managed by this Domain.
+     * @maxLength 32
+     */
+    HomeEfsFileSystemId: string;
+    /**
+     * The ID of the security group that authorizes traffic between the `RSessionGateway` apps and the `RStudioServerPro` app.
+     * @maxLength 32
+     * @pattern [-0-9a-zA-Z]+
+     */
+    SecurityGroupIdForDomainBoundary: 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.
+     * @pattern ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::[0-9]+:application/[a-zA-Z0-9-_.]+/apl-[a-zA-Z0-9]+$
+     */
+    SingleSignOnApplicationArn: string;
+    /**
+     * The IAM Identity Center managed application instance ID.
+     * @maxLength 256
+     */
+    SingleSignOnManagedApplicationInstanceId: string;
+    /**
+     * The URL for the Domain.
+     * @maxLength 1024
+     */
+    Url: string;
+};
+/**
+ * The instance type that the image version runs on.
+ */
+export type AppInstanceType = "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.m5d.large" | "ml.m5d.xlarge" | "ml.m5d.2xlarge" | "ml.m5d.4xlarge" | "ml.m5d.8xlarge" | "ml.m5d.12xlarge" | "ml.m5d.16xlarge" | "ml.m5d.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.p3dn.24xlarge" | "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.g5.xlarge" | "ml.g5.2xlarge" | "ml.g5.4xlarge" | "ml.g5.8xlarge" | "ml.g5.12xlarge" | "ml.g5.16xlarge" | "ml.g5.24xlarge" | "ml.g5.48xlarge" | "ml.g6.xlarge" | "ml.g6.2xlarge" | "ml.g6.4xlarge" | "ml.g6.8xlarge" | "ml.g6.12xlarge" | "ml.g6.16xlarge" | "ml.g6.24xlarge" | "ml.g6.48xlarge" | "ml.g6e.xlarge" | "ml.g6e.2xlarge" | "ml.g6e.4xlarge" | "ml.g6e.8xlarge" | "ml.g6e.12xlarge" | "ml.g6e.16xlarge" | "ml.g6e.24xlarge" | "ml.g6e.48xlarge" | "ml.geospatial.interactive" | "ml.p4d.24xlarge" | "ml.p4de.24xlarge" | "ml.trn1.2xlarge" | "ml.trn1.32xlarge" | "ml.trn1n.32xlarge" | "ml.p5.48xlarge" | "ml.m6i.large" | "ml.m6i.xlarge" | "ml.m6i.2xlarge" | "ml.m6i.4xlarge" | "ml.m6i.8xlarge" | "ml.m6i.12xlarge" | "ml.m6i.16xlarge" | "ml.m6i.24xlarge" | "ml.m6i.32xlarge" | "ml.m7i.large" | "ml.m7i.xlarge" | "ml.m7i.2xlarge" | "ml.m7i.4xlarge" | "ml.m7i.8xlarge" | "ml.m7i.12xlarge" | "ml.m7i.16xlarge" | "ml.m7i.24xlarge" | "ml.m7i.48xlarge" | "ml.c6i.large" | "ml.c6i.xlarge" | "ml.c6i.2xlarge" | "ml.c6i.4xlarge" | "ml.c6i.8xlarge" | "ml.c6i.12xlarge" | "ml.c6i.16xlarge" | "ml.c6i.24xlarge" | "ml.c6i.32xlarge" | "ml.c7i.large" | "ml.c7i.xlarge" | "ml.c7i.2xlarge" | "ml.c7i.4xlarge" | "ml.c7i.8xlarge" | "ml.c7i.12xlarge" | "ml.c7i.16xlarge" | "ml.c7i.24xlarge" | "ml.c7i.48xlarge" | "ml.r6i.large" | "ml.r6i.xlarge" | "ml.r6i.2xlarge" | "ml.r6i.4xlarge" | "ml.r6i.8xlarge" | "ml.r6i.12xlarge" | "ml.r6i.16xlarge" | "ml.r6i.24xlarge" | "ml.r6i.32xlarge" | "ml.r7i.large" | "ml.r7i.xlarge" | "ml.r7i.2xlarge" | "ml.r7i.4xlarge" | "ml.r7i.8xlarge" | "ml.r7i.12xlarge" | "ml.r7i.16xlarge" | "ml.r7i.24xlarge" | "ml.r7i.48xlarge" | "ml.m6id.large" | "ml.m6id.xlarge" | "ml.m6id.2xlarge" | "ml.m6id.4xlarge" | "ml.m6id.8xlarge" | "ml.m6id.12xlarge" | "ml.m6id.16xlarge" | "ml.m6id.24xlarge" | "ml.m6id.32xlarge" | "ml.c6id.large" | "ml.c6id.xlarge" | "ml.c6id.2xlarge" | "ml.c6id.4xlarge" | "ml.c6id.8xlarge" | "ml.c6id.12xlarge" | "ml.c6id.16xlarge" | "ml.c6id.24xlarge" | "ml.c6id.32xlarge" | "ml.r6id.large" | "ml.r6id.xlarge" | "ml.r6id.2xlarge" | "ml.r6id.4xlarge" | "ml.r6id.8xlarge" | "ml.r6id.12xlarge" | "ml.r6id.16xlarge" | "ml.r6id.24xlarge" | "ml.r6id.32xlarge";
+/**
+ * Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
+ */
+export type AppLifecycleManagement = {
+    /**
+     * Settings related to idle shutdown of Studio applications.
+     */
+    IdleSettings?: IdleSettings | undefined;
+};
+export type AppType = "JupyterServer" | "TensorBoard" | "RStudioServerPro" | "JupyterLab" | "CodeEditor" | "DetailedProfiler" | "Canvas";
+/**
+ * The Code Editor application settings.
+ *
+ * For more information about Code Editor, see [Get started with Code Editor in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html) .
+ */
+export type CodeEditorAppSettings = {
+    /**
+     * Settings that are used to configure and manage the lifecycle of CodeEditor applications.
+     */
+    AppLifecycleManagement?: AppLifecycleManagement | undefined;
+    /**
+     * The lifecycle configuration that runs before the default lifecycle configuration.
+     * @maxLength 256
+     * @pattern ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$
+     */
+    BuiltInLifecycleConfigArn?: string | undefined;
+    /**
+     * A list of custom SageMaker images that are configured to run as a Code Editor app.
+     */
+    CustomImages?: CustomImage[] | undefined;
+    /**
+     * The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the Code Editor app.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.
+     */
+    LifecycleConfigArns?: string[] | undefined;
+};
+/**
+ * A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
+ */
+export type CodeRepository = {
+    /**
+     * The URL of the Git repository.
+     * @maxLength 256
+     * @pattern ^https://([.\-_a-zA-Z0-9]+/?){3,1016}$
+     */
+    RepositoryUrl: string;
+};
+/**
+ * The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
+ */
+export type CustomFileSystemConfig = {
+    /**
+     * The settings for a custom Amazon EFS file system.
+     */
+    EFSFileSystemConfig?: EFSFileSystemConfig | undefined;
+    /**
+     * The settings for a custom Amazon FSx for Lustre file system.
+     */
+    FSxLustreFileSystemConfig?: FSxLustreFileSystemConfig | undefined;
+};
+/**
+ * A custom SageMaker AI image. For more information, see [Bring your own SageMaker AI image](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .
+ */
+export type CustomImage = {
+    /**
+     * The name of the AppImageConfig.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
+     */
+    AppImageConfigName: string;
+    /**
+     * The name of the CustomImage. Must be unique to your account.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
+     */
+    ImageName: string;
+    /**
+     * The version number of the CustomImage.
+     * @min 0
+     */
+    ImageVersionNumber?: number | undefined;
+};
+/**
+ * Details about the POSIX identity that is used for file system operations.
+ */
+export type CustomPosixUserConfig = {
+    /**
+     * The POSIX group ID.
+     * @min 1001
+     * @max 4000000
+     */
+    Gid: number;
+    /**
+     * The POSIX user ID.
+     * @min 10000
+     * @max 4000000
+     */
+    Uid: number;
+};
+/**
+ * A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
+ */
+export type DefaultEbsStorageSettings = {
+    /**
+     * The default size of the EBS storage volume for a space.
+     */
+    DefaultEbsVolumeSizeInGb: number;
+    /**
+     * The maximum size of the EBS storage volume for a space.
+     */
+    MaximumEbsVolumeSizeInGb: number;
+};
+/**
+ * The default settings for shared spaces that users create in the domain.
+ *
+ * SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
+ */
+export type DefaultSpaceSettings = {
+    /**
+     * The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
+     */
+    CustomFileSystemConfigs?: CustomFileSystemConfig[] | undefined;
+    /**
+     * The Jupyter lab's custom posix user configurations.
+     */
+    CustomPosixUserConfig?: CustomPosixUserConfig | undefined;
+    /**
+     * The ARN of the execution role for the space.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     */
+    ExecutionRole: string;
+    /**
+     * The JupyterLab app settings.
+     */
+    JupyterLabAppSettings?: JupyterLabAppSettings | undefined;
+    /**
+     * The JupyterServer app settings.
+     */
+    JupyterServerAppSettings?: JupyterServerAppSettings | undefined;
+    /**
+     * The KernelGateway app settings.
+     */
+    KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined;
+    /**
+     * The security group IDs for the Amazon VPC that the space uses for communication.
+     */
+    SecurityGroups?: string[] | undefined;
+    /**
+     * Default storage settings for a space.
+     */
+    SpaceStorageSettings?: DefaultSpaceStorageSettings | undefined;
+};
+/**
+ * The default storage settings for a space.
+ */
+export type DefaultSpaceStorageSettings = {
+    /**
+     * The default EBS storage settings for a space.
+     */
+    DefaultEbsStorageSettings?: DefaultEbsStorageSettings | undefined;
+};
+/**
+ * A collection of settings that configure the domain's Docker interaction.
+ */
+export type DockerSettings = {
+    /**
+     * Indicates whether the domain can access Docker.
+     */
+    EnableDockerAccess?: "ENABLED" | "DISABLED" | undefined;
+    /**
+     * The list of AWS accounts that are trusted when the domain is created in VPC-only mode.
+     */
+    VpcOnlyTrustedAccounts?: string[] | undefined;
+};
+/**
+ * A collection of settings that apply to the `SageMaker Domain` . These settings are specified through the `CreateDomain` API call.
+ */
+export type DomainSettings = {
+    /**
+     * A collection of settings that configure the domain's Docker interaction.
+     */
+    DockerSettings?: DockerSettings | undefined;
+    /**
+     * The configuration for attaching a SageMaker AI user profile name to the execution role as a [sts:SourceIdentity key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) .
+     */
+    ExecutionRoleIdentityConfig?: "USER_PROFILE_NAME" | "DISABLED" | undefined;
+    /**
+     * A collection of settings that configure the `RStudioServerPro` Domain-level app.
+     */
+    RStudioServerProDomainSettings?: RStudioServerProDomainSettings | undefined;
+    /**
+     * The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
+     */
+    SecurityGroupIds?: string[] | undefined;
+};
+/**
+ * The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.
+ */
+export type EFSFileSystemConfig = {
+    /**
+     * The ID of your Amazon EFS file system.
+     * @minLength 11
+     * @maxLength 21
+     * @pattern ^(fs-[0-9a-f]{8,})$
+     */
+    FileSystemId: string;
+    /**
+     * The path to the file system directory that is accessible in Amazon SageMaker AI Studio. Permitted users can access only this directory and below.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^\/\S*$
+     */
+    FileSystemPath?: string | undefined;
+};
+/**
+ * The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
+ */
+export type FSxLustreFileSystemConfig = {
+    /**
+     * The globally unique, 17-digit, ID of the file system, assigned by Amazon FSx for Lustre.
+     * @minLength 11
+     * @maxLength 21
+     * @pattern ^(fs-[0-9a-f]{8,})$
+     */
+    FileSystemId: string;
+    /**
+     * The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^\/\S*$
+     */
+    FileSystemPath?: string | undefined;
+};
+export type HiddenSageMakerImage = {
+    /**
+     * The SageMaker image name that you are hiding from the Studio user interface.
+     */
+    SageMakerImageName?: "sagemaker_distribution" | undefined;
+    VersionAliases?: string[] | undefined;
+};
+/**
+ * Settings related to idle shutdown of Studio applications.
+ */
+export type IdleSettings = {
+    /**
+     * The time that SageMaker waits after the application becomes idle before shutting it down.
+     */
+    IdleTimeoutInMinutes?: number | undefined;
+    /**
+     * Indicates whether idle shutdown is activated for the application type.
+     */
+    LifecycleManagement?: LifecycleManagement | undefined;
+    /**
+     * The maximum value in minutes that custom idle shutdown can be set to by the user.
+     */
+    MaxIdleTimeoutInMinutes?: number | undefined;
+    /**
+     * The minimum value in minutes that custom idle shutdown can be set to by the user.
+     */
+    MinIdleTimeoutInMinutes?: number | undefined;
+};
+/**
+ * The settings for the JupyterLab application.
+ */
+export type JupyterLabAppSettings = {
+    /**
+     * Indicates whether idle shutdown is activated for JupyterLab applications.
+     */
+    AppLifecycleManagement?: AppLifecycleManagement | undefined;
+    /**
+     * The lifecycle configuration that runs before the default lifecycle configuration.
+     * @maxLength 256
+     * @pattern ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$
+     */
+    BuiltInLifecycleConfigArn?: string | undefined;
+    /**
+     * A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.
+     */
+    CodeRepositories?: CodeRepository[] | undefined;
+    /**
+     * A list of custom SageMaker images that are configured to run as a JupyterLab app.
+     */
+    CustomImages?: CustomImage[] | undefined;
+    /**
+     * The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.
+     */
+    LifecycleConfigArns?: string[] | undefined;
+};
+/**
+ * The JupyterServer app settings.
+ */
+export type JupyterServerAppSettings = {
+    /**
+     * The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the `DefaultResourceSpec` parameter is also required.
+     *
+     * > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list.
+     */
+    LifecycleConfigArns?: string[] | undefined;
+};
+/**
+ * The KernelGateway app settings.
+ */
+export type KernelGatewayAppSettings = {
+    /**
+     * A list of custom SageMaker AI images that are configured to run as a KernelGateway app.
+     *
+     * The maximum number of custom images are as follows.
+     *
+     * - On a domain level: 200
+     * - On a space level: 5
+     * - On a user profile level: 5
+     */
+    CustomImages?: CustomImage[] | undefined;
+    /**
+     * The default instance type and the Amazon Resource Name (ARN) of the default SageMaker AI image used by the KernelGateway app.
+     *
+     * > The Amazon SageMaker AI Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the AWS CLI or AWS CloudFormation and the instance type parameter value is not passed.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
+     *
+     * > To remove a Lifecycle Config, you must set `LifecycleConfigArns` to an empty list.
+     */
+    LifecycleConfigArns?: string[] | undefined;
+};
+/**
+ * A flag to enable/disable AppLifecycleManagement settings
+ */
+export type LifecycleManagement = "ENABLED" | "DISABLED";
+export type MlTools = "DataWrangler" | "FeatureStore" | "EmrClusters" | "AutoMl" | "Experiments" | "Training" | "ModelEvaluation" | "Pipelines" | "Models" | "JumpStart" | "InferenceRecommender" | "Endpoints" | "Projects" | "InferenceOptimization" | "HyperPodClusters" | "Comet" | "DeepchecksLLMEvaluation" | "Fiddler" | "LakeraGuard" | "PerformanceEvaluation";
+/**
+ * A collection of settings that apply to an `RSessionGateway` app.
+ */
+export type RSessionAppSettings = {
+    /**
+     * A list of custom SageMaker AI images that are configured to run as a RSession app.
+     */
+    CustomImages?: CustomImage[] | undefined;
+    /**
+     * Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+};
+/**
+ * A collection of settings that configure user interaction with the `RStudioServerPro` app.
+ */
+export type RStudioServerProAppSettings = {
+    /**
+     * Indicates whether the current user has access to the `RStudioServerPro` app.
+     */
+    AccessStatus?: "ENABLED" | "DISABLED" | undefined;
+    /**
+     * 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.
+     */
+    UserGroup?: "R_STUDIO_ADMIN" | "R_STUDIO_USER" | undefined;
+};
+/**
+ * A collection of settings that configure the `RStudioServerPro` Domain-level app.
+ */
+export type RStudioServerProDomainSettings = {
+    /**
+     * A collection that defines the default `InstanceType` , `SageMakerImageArn` , and `SageMakerImageVersionArn` for the Domain.
+     */
+    DefaultResourceSpec?: ResourceSpec | undefined;
+    /**
+     * The ARN of the execution role for the `RStudioServerPro` Domain-level app.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     */
+    DomainExecutionRoleArn: string;
+    /**
+     * A URL pointing to an RStudio Connect server.
+     * @pattern ^(https:|http:|www\.)\S*
+     */
+    RStudioConnectUrl?: string | undefined;
+    /**
+     * A URL pointing to an RStudio Package Manager server.
+     * @pattern ^(https:|http:|www\.)\S*
+     */
+    RStudioPackageManagerUrl?: string | undefined;
+};
+/**
+ * Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
+ *
+ * > When both `SageMakerImageVersionArn` and `SageMakerImageArn` are passed, `SageMakerImageVersionArn` is used. Any updates to `SageMakerImageArn` will not take effect if `SageMakerImageVersionArn` already exists in the `ResourceSpec` because `SageMakerImageVersionArn` always takes precedence. To clear the value set for `SageMakerImageVersionArn` , pass `None` as the value.
+ */
+export type ResourceSpec = {
+    /**
+     * The instance type that the image version runs on.
+     *
+     * > *JupyterServer apps* only support the `system` value.
+     * >
+     * > For *KernelGateway apps* , the `system` value is translated to `ml.t3.medium` . KernelGateway apps also support all other values for available instance types.
+     */
+    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" | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
+     * @maxLength 256
+     * @pattern ^(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*|None)$
+     */
+    LifecycleConfigArn?: string | undefined;
+    /**
+     * The ARN of the SageMaker AI image that the image version belongs to.
+     * @maxLength 256
+     * @pattern ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
+     */
+    SageMakerImageArn?: string | undefined;
+    /**
+     * The ARN of the image version created on the instance. To clear the value set for `SageMakerImageVersionArn` , pass `None` as the value.
+     * @maxLength 256
+     * @pattern ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*‍/[0-9]+$
+     */
+    SageMakerImageVersionArn?: string | undefined;
+};
+/**
+ * Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called, and as part of `UserSettings` when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called.
+ */
+export type SharingSettings = {
+    /**
+     * Whether to include the notebook cell output when sharing the notebook. The default is `Disabled` .
+     */
+    NotebookOutputOption?: "Allowed" | "Disabled" | undefined;
+    /**
+     * 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.
+     * @maxLength 2048
+     * @pattern .*
+     */
+    S3KmsKeyId?: string | undefined;
+    /**
+     * When `NotebookOutputOption` is `Allowed` , the Amazon S3 bucket used to store the shared notebook snapshots.
+     * @maxLength 1024
+     * @pattern ^(https|s3)://([^/]+)/?(.*)$
+     */
+    S3OutputPath?: string | undefined;
+};
+/**
+ * Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
+ */
+export type StudioWebPortalSettings = {
+    /**
+     * The [Applications supported in Studio](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html) that are hidden from the Studio left navigation pane.
+     */
+    HiddenAppTypes?: AppType[] | undefined;
+    /**
+     * The instance types you are hiding from the Studio user interface.
+     */
+    HiddenInstanceTypes?: AppInstanceType[] | undefined;
+    /**
+     * The machine learning tools that are hidden from the Studio left navigation pane.
+     */
+    HiddenMlTools?: MlTools[] | undefined;
+    /**
+     * The version aliases you are hiding from the Studio user interface.
+     */
+    HiddenSageMakerImageVersionAliases?: HiddenSageMakerImage[] | undefined;
+};
+/**
+ * A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the [CreateUserProfile](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called, and as `DefaultUserSettings` when the [CreateDomain](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) API is called.
+ *
+ * `SecurityGroups` is aggregated when specified in both calls. For all other settings in `UserSettings` , the values specified in `CreateUserProfile` take precedence over those specified in `CreateDomain` .
+ */
+export type UserSettings = {
+    /**
+     * Indicates whether auto-mounting of an EFS volume is supported for the user profile.
+     */
+    AutoMountHomeEFS?: "Enabled" | "Disabled" | "DefaultAsDomain" | undefined;
+    /**
+     * 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.
+     */
+    CodeEditorAppSettings?: CodeEditorAppSettings | undefined;
+    /**
+     * The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI 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.
+     */
+    CustomFileSystemConfigs?: CustomFileSystemConfig[] | undefined;
+    /**
+     * 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.
+     */
+    CustomPosixUserConfig?: CustomPosixUserConfig | undefined;
+    /**
+     * The default experience that the user is directed to when accessing the domain. The supported values are:
+     *
+     * - `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .
+     * - `app:JupyterServer:` : Indicates that Studio Classic is the default experience.
+     * @maxLength 1023
+     */
+    DefaultLandingUri?: string | undefined;
+    /**
+     * The execution role for the user.
+     *
+     * SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
+     */
+    ExecutionRole: string;
+    /**
+     * 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.
+     */
+    JupyterLabAppSettings?: JupyterLabAppSettings | undefined;
+    /**
+     * The Jupyter server's app settings.
+     */
+    JupyterServerAppSettings?: JupyterServerAppSettings | undefined;
+    /**
+     * The kernel gateway app settings.
+     */
+    KernelGatewayAppSettings?: KernelGatewayAppSettings | undefined;
+    /**
+     * A collection of settings that configure the `RSessionGateway` app.
+     */
+    RSessionAppSettings?: RSessionAppSettings | undefined;
+    /**
+     * A collection of settings that configure user interaction with the `RStudioServerPro` app.
+     */
+    RStudioServerProAppSettings?: RStudioServerProAppSettings | undefined;
+    /**
+     * The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
+     *
+     * Optional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` .
+     *
+     * Required when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` , unless specified as part of the `DefaultUserSettings` for the domain.
+     *
+     * Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
+     *
+     * SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
+     */
+    SecurityGroups?: string[] | undefined;
+    /**
+     * Specifies options for sharing Amazon SageMaker AI Studio notebooks.
+     */
+    SharingSettings?: SharingSettings | undefined;
+    /**
+     * 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.
+     */
+    SpaceStorageSettings?: DefaultSpaceStorageSettings | undefined;
+    /**
+     * Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain.
+     */
+    StudioWebPortal?: "ENABLED" | "DISABLED" | undefined;
+    /**
+     * Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
+     */
+    StudioWebPortalSettings?: StudioWebPortalSettings | undefined;
+};
+//# sourceMappingURL=aws-sagemaker-domain.d.ts.map