Package software.amazon.awscdk.services.sagemaker

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.358Z")
@Stability(Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .authMode("authMode")
         .defaultUserSettings(UserSettingsProperty.builder()
                 .executionRole("executionRole")
                 // the properties below are optional
                 .autoMountHomeEfs("autoMountHomeEfs")
                 .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder()
                         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                                 .idleSettings(IdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .lifecycleManagement("lifecycleManagement")
                                         .maxIdleTimeoutInMinutes(123)
                                         .minIdleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
                         .efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .s3FileSystemConfig(S3FileSystemConfigProperty.builder()
                                 .mountPath("mountPath")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .customPosixUserConfig(CustomPosixUserConfigProperty.builder()
                         .gid(123)
                         .uid(123)
                         .build())
                 .defaultLandingUri("defaultLandingUri")
                 .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
                         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                                 .idleSettings(IdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .lifecycleManagement("lifecycleManagement")
                                         .maxIdleTimeoutInMinutes(123)
                                         .minIdleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                         .codeRepositories(List.of(CodeRepositoryProperty.builder()
                                 .repositoryUrl("repositoryUrl")
                                 .build()))
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .rSessionAppSettings(RSessionAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                         .accessStatus("accessStatus")
                         .userGroup("userGroup")
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .sharingSettings(SharingSettingsProperty.builder()
                         .notebookOutputOption("notebookOutputOption")
                         .s3KmsKeyId("s3KmsKeyId")
                         .s3OutputPath("s3OutputPath")
                         .build())
                 .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
                         .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
                                 .defaultEbsVolumeSizeInGb(123)
                                 .maximumEbsVolumeSizeInGb(123)
                                 .build())
                         .build())
                 .studioWebPortal("studioWebPortal")
                 .studioWebPortalSettings(StudioWebPortalSettingsProperty.builder()
                         .hiddenAppTypes(List.of("hiddenAppTypes"))
                         .hiddenInstanceTypes(List.of("hiddenInstanceTypes"))
                         .hiddenMlTools(List.of("hiddenMlTools"))
                         .hiddenSageMakerImageVersionAliases(List.of(HiddenSageMakerImageProperty.builder()
                                 .sageMakerImageName("sageMakerImageName")
                                 .versionAliases(List.of("versionAliases"))
                                 .build()))
                         .build())
                 .build())
         .domainName("domainName")
         // the properties below are optional
         .appNetworkAccessType("appNetworkAccessType")
         .appSecurityGroupManagement("appSecurityGroupManagement")
         .defaultSpaceSettings(DefaultSpaceSettingsProperty.builder()
                 .executionRole("executionRole")
                 // the properties below are optional
                 .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
                         .efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .s3FileSystemConfig(S3FileSystemConfigProperty.builder()
                                 .mountPath("mountPath")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .customPosixUserConfig(CustomPosixUserConfigProperty.builder()
                         .gid(123)
                         .uid(123)
                         .build())
                 .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
                         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                                 .idleSettings(IdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .lifecycleManagement("lifecycleManagement")
                                         .maxIdleTimeoutInMinutes(123)
                                         .minIdleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                         .codeRepositories(List.of(CodeRepositoryProperty.builder()
                                 .repositoryUrl("repositoryUrl")
                                 .build()))
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
                         .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
                                 .defaultEbsVolumeSizeInGb(123)
                                 .maximumEbsVolumeSizeInGb(123)
                                 .build())
                         .build())
                 .build())
         .domainSettings(DomainSettingsProperty.builder()
                 .dockerSettings(DockerSettingsProperty.builder()
                         .enableDockerAccess("enableDockerAccess")
                         .vpcOnlyTrustedAccounts(List.of("vpcOnlyTrustedAccounts"))
                         .build())
                 .executionRoleIdentityConfig("executionRoleIdentityConfig")
                 .ipAddressType("ipAddressType")
                 .rStudioServerProDomainSettings(RStudioServerProDomainSettingsProperty.builder()
                         .domainExecutionRoleArn("domainExecutionRoleArn")
                         // the properties below are optional
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .rStudioConnectUrl("rStudioConnectUrl")
                         .rStudioPackageManagerUrl("rStudioPackageManagerUrl")
                         .build())
                 .securityGroupIds(List.of("securityGroupIds"))
                 .unifiedStudioSettings(UnifiedStudioSettingsProperty.builder()
                         .domainAccountId("domainAccountId")
                         .domainId("domainId")
                         .domainRegion("domainRegion")
                         .environmentId("environmentId")
                         .projectId("projectId")
                         .projectS3Path("projectS3Path")
                         .studioWebPortalAccess("studioWebPortalAccess")
                         .build())
                 .build())
         .kmsKeyId("kmsKeyId")
         .subnetIds(List.of("subnetIds"))
         .tagPropagation("tagPropagation")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcId("vpcId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainProps.Builder	builder()
default String	getAppNetworkAccessType()	Specifies the VPC used for non-EFS traffic.
default String	getAppSecurityGroupManagement()	The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
String	getAuthMode()	The mode of authentication that members use to access the Domain.
default Object	getDefaultSpaceSettings()	The default settings for shared spaces that users create in the domain.
Object	getDefaultUserSettings()	The default user settings.
String	getDomainName()	The domain name.
default Object	getDomainSettings()	A collection of settings that apply to the SageMaker Domain .
default String	getKmsKeyId()	SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.
default List<Object>	getSubnetIds()	The VPC subnets that Studio uses for communication.
default String	getTagPropagation()	Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
default List<CfnTag>	getTags()	Tags to associated with the Domain.
default Object	getVpcId()	The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthMode

@Stability(Stable)
@NotNull
String getAuthMode()

The mode of authentication that members use to access the Domain.

Valid Values : SSO | IAM

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-authmode

getDefaultUserSettings

@Stability(Stable)
@NotNull
Object getDefaultUserSettings()

The default user settings.

Returns union: either IResolvable or CfnDomain.UserSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultusersettings

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainname

getAppNetworkAccessType

@Stability(Stable)
@Nullable
default String getAppNetworkAccessType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appnetworkaccesstype

getAppSecurityGroupManagement

@Stability(Stable)
@Nullable
default String getAppSecurityGroupManagement()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appsecuritygroupmanagement

getDefaultSpaceSettings

@Stability(Stable)
@Nullable
default Object getDefaultSpaceSettings()

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.

Returns union: either IResolvable or CfnDomain.DefaultSpaceSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultspacesettings

getDomainSettings

@Stability(Stable)
@Nullable
default Object getDomainSettings()

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Returns union: either IResolvable or CfnDomain.DomainSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainsettings

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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 : .*

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-kmskeyid

getSubnetIds

@Stability(Stable)
@Nullable
default List<Object> getSubnetIds()

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]+

Returns union: Listinvalid input: '<'either String or ISubnetRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-subnetids

getTagPropagation

@Stability(Stable)
@Nullable
default String getTagPropagation()

Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tagpropagation

getTags

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tags

getVpcId

@Stability(Stable)
@Nullable
default Object getVpcId()

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]+

Returns union: either String or IVPCRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-vpcid

builder

@Stability(Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps