Package software.amazon.awscdk.services.sagemaker

Class CfnDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnDomain

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggable, IDomainRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:49.650Z")
@Stability(Stable)
public class CfnDomain
extends CfnResource
implements IInspectable, IDomainRef, ITaggable

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 .

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 .

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.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .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	Class	Description
static interface	CfnDomain.AppLifecycleManagementProperty	Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
static final class	CfnDomain.Builder	A fluent builder for CfnDomain.
static interface	CfnDomain.CodeEditorAppSettingsProperty	The Code Editor application settings.
static interface	CfnDomain.CodeRepositoryProperty	A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
static interface	CfnDomain.CustomFileSystemConfigProperty	The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnDomain.CustomImageProperty	A custom SageMaker AI image.
static interface	CfnDomain.CustomPosixUserConfigProperty	Details about the POSIX identity that is used for file system operations.
static interface	CfnDomain.DefaultEbsStorageSettingsProperty	A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
static interface	CfnDomain.DefaultSpaceSettingsProperty	The default settings for shared spaces that users create in the domain.
static interface	CfnDomain.DefaultSpaceStorageSettingsProperty	The default storage settings for a space.
static interface	CfnDomain.DockerSettingsProperty	A collection of settings that configure the domain's Docker interaction.
static interface	CfnDomain.DomainSettingsProperty	A collection of settings that apply to the SageMaker Domain .
static interface	CfnDomain.EFSFileSystemConfigProperty	The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnDomain.FSxLustreFileSystemConfigProperty	The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
static interface	CfnDomain.HiddenSageMakerImageProperty	The SageMaker images that are hidden from the Studio user interface.
static interface	CfnDomain.IdleSettingsProperty	Settings related to idle shutdown of Studio applications.
static interface	CfnDomain.JupyterLabAppSettingsProperty	The settings for the JupyterLab application.
static interface	CfnDomain.JupyterServerAppSettingsProperty	The JupyterServer app settings.
static interface	CfnDomain.KernelGatewayAppSettingsProperty	The KernelGateway app settings.
static interface	CfnDomain.ResourceSpecProperty	Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
static interface	CfnDomain.RSessionAppSettingsProperty	A collection of settings that apply to an RSessionGateway app.
static interface	CfnDomain.RStudioServerProAppSettingsProperty	A collection of settings that configure user interaction with the RStudioServerPro app.
static interface	CfnDomain.RStudioServerProDomainSettingsProperty	A collection of settings that configure the RStudioServerPro Domain-level app.
static interface	CfnDomain.S3FileSystemConfigProperty	Configuration for the custom Amazon S3 file system.
static interface	CfnDomain.SharingSettingsProperty	Specifies options when sharing an Amazon SageMaker Studio notebook.
static interface	CfnDomain.StudioWebPortalSettingsProperty	Studio settings.
static interface	CfnDomain.UnifiedStudioSettingsProperty	The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
static interface	CfnDomain.UserSettingsProperty	A collection of settings that apply to users of Amazon SageMaker Studio.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.IDomainRef

IDomainRef.Jsii$Default, IDomainRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props)

Method Summary

Modifier and Type	Method	Description
static IDomainRef	fromDomainArn(software.constructs.Construct scope, String id, String arn)	Creates a new IDomainRef from an ARN.
static IDomainRef	fromDomainId(software.constructs.Construct scope, String id, String domainId)	Creates a new IDomainRef from a domainId.
String	getAppNetworkAccessType()	Specifies the VPC used for non-EFS traffic.
String	getAppSecurityGroupManagement()	The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
String	getAttrDomainArn()	The Amazon Resource Name (ARN) of the Domain, such as arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name .
String	getAttrDomainId()	The Domain ID.
String	getAttrHomeEfsFileSystemId()	The ID of the Amazon Elastic File System (EFS) managed by this Domain.
String	getAttrSecurityGroupIdForDomainBoundary()	The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
String	getAttrSingleSignOnApplicationArn()	The ARN of the application managed by SageMaker in IAM Identity Center.
String	getAttrSingleSignOnManagedApplicationInstanceId()	The IAM Identity Center managed application instance ID.
String	getAttrUrl()	The URL for the Domain.
String	getAuthMode()	The mode of authentication that members use to access the Domain.
protected Map<String,Object>	getCfnProperties()
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.
DomainReference	getDomainRef()	A reference to a Domain resource.
Object	getDomainSettings()	A collection of settings that apply to the SageMaker Domain .
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.
List<String>	getSubnetIds()	The VPC subnets that Studio uses for communication.
String	getTagPropagation()	Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Tags to associated with the Domain.
String	getVpcId()	The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppNetworkAccessType(String value)	Specifies the VPC used for non-EFS traffic.
void	setAppSecurityGroupManagement(String value)	The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
void	setAuthMode(String value)	The mode of authentication that members use to access the Domain.
void	setDefaultSpaceSettings(IResolvable value)	The default settings for shared spaces that users create in the domain.
void	setDefaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty value)	The default settings for shared spaces that users create in the domain.
void	setDefaultUserSettings(IResolvable value)	The default user settings.
void	setDefaultUserSettings(CfnDomain.UserSettingsProperty value)	The default user settings.
void	setDomainName(String value)	The domain name.
void	setDomainSettings(IResolvable value)	A collection of settings that apply to the SageMaker Domain .
void	setDomainSettings(CfnDomain.DomainSettingsProperty value)	A collection of settings that apply to the SageMaker Domain .
void	setKmsKeyId(String value)	SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.
void	setSubnetIds(List<String> value)	The VPC subnets that Studio uses for communication.
void	setTagPropagation(String value)	Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
void	setTagsRaw(List<CfnTag> value)	Tags to associated with the Domain.
void	setVpcId(String value)	The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomain

@Stability(Stable)
public CfnDomain(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDomainProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

fromDomainArn

@Stability(Stable)
@NotNull
public static IDomainRef fromDomainArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IDomainRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromDomainId

@Stability(Stable)
@NotNull
public static IDomainRef fromDomainId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String domainId)

Creates a new IDomainRef from a domainId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

domainId - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDomainArn

@Stability(Stable)
@NotNull
public String getAttrDomainArn()

The Amazon Resource Name (ARN) of the Domain, such as arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name .

getAttrDomainId

@Stability(Stable)
@NotNull
public String getAttrDomainId()

The Domain ID.

getAttrHomeEfsFileSystemId

@Stability(Stable)
@NotNull
public String getAttrHomeEfsFileSystemId()

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

getAttrSecurityGroupIdForDomainBoundary

@Stability(Stable)
@NotNull
public String getAttrSecurityGroupIdForDomainBoundary()

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

getAttrSingleSignOnApplicationArn

@Stability(Stable)
@NotNull
public String getAttrSingleSignOnApplicationArn()

The ARN of the application managed by SageMaker in IAM Identity Center.

This value is only returned for domains created after October 1, 2023.

getAttrSingleSignOnManagedApplicationInstanceId

@Stability(Stable)
@NotNull
public String getAttrSingleSignOnManagedApplicationInstanceId()

The IAM Identity Center managed application instance ID.

getAttrUrl

@Stability(Stable)
@NotNull
public String getAttrUrl()

The URL for the Domain.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomainRef

@Stability(Stable)
@NotNull
public DomainReference getDomainRef()

A reference to a Domain resource.

Specified by:

getDomainRef in interface IDomainRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAuthMode

@Stability(Stable)
@NotNull
public String getAuthMode()

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

setAuthMode

@Stability(Stable)
public void setAuthMode(@NotNull
 String value)

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

getDefaultUserSettings

@Stability(Stable)
@NotNull
public Object getDefaultUserSettings()

The default user settings.

Returns union: either IResolvable or CfnDomain.UserSettingsProperty

setDefaultUserSettings

@Stability(Stable)
public void setDefaultUserSettings(@NotNull
 IResolvable value)

The default user settings.

setDefaultUserSettings

@Stability(Stable)
public void setDefaultUserSettings(@NotNull
 CfnDomain.UserSettingsProperty value)

The default user settings.

getDomainName

@Stability(Stable)
@NotNull
public String getDomainName()

The domain name.

setDomainName

@Stability(Stable)
public void setDomainName(@NotNull
 String value)

The domain name.

getAppNetworkAccessType

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

Specifies the VPC used for non-EFS traffic.

The default value is PublicInternetOnly .

setAppNetworkAccessType

@Stability(Stable)
public void setAppNetworkAccessType(@Nullable
 String value)

Specifies the VPC used for non-EFS traffic.

The default value is PublicInternetOnly .

getAppSecurityGroupManagement

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

The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.

setAppSecurityGroupManagement

@Stability(Stable)
public void setAppSecurityGroupManagement(@Nullable
 String value)

The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.

getDefaultSpaceSettings

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

The default settings for shared spaces that users create in the domain.

Returns union: either IResolvable or CfnDomain.DefaultSpaceSettingsProperty

setDefaultSpaceSettings

@Stability(Stable)
public void setDefaultSpaceSettings(@Nullable
 IResolvable value)

The default settings for shared spaces that users create in the domain.

setDefaultSpaceSettings

@Stability(Stable)
public void setDefaultSpaceSettings(@Nullable
 CfnDomain.DefaultSpaceSettingsProperty value)

The default settings for shared spaces that users create in the domain.

getDomainSettings

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

A collection of settings that apply to the SageMaker Domain .

Returns union: either IResolvable or CfnDomain.DomainSettingsProperty

setDomainSettings

@Stability(Stable)
public void setDomainSettings(@Nullable
 IResolvable value)

A collection of settings that apply to the SageMaker Domain .

setDomainSettings

@Stability(Stable)
public void setDomainSettings(@Nullable
 CfnDomain.DomainSettingsProperty value)

A collection of settings that apply to the SageMaker Domain .

getKmsKeyId

@Stability(Stable)
@Nullable
public 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.

setKmsKeyId

@Stability(Stable)
public void setKmsKeyId(@Nullable
 String value)

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.

getSubnetIds

@Stability(Stable)
@Nullable
public List<String> getSubnetIds()

The VPC subnets that Studio uses for communication.

setSubnetIds

@Stability(Stable)
public void setSubnetIds(@Nullable
 List<String> value)

The VPC subnets that Studio uses for communication.

getTagPropagation

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

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

setTagPropagation

@Stability(Stable)
public void setTagPropagation(@Nullable
 String value)

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

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Tags to associated with the Domain.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Tags to associated with the Domain.

getVpcId

@Stability(Stable)
@Nullable
public String getVpcId()

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

setVpcId

@Stability(Stable)
public void setVpcId(@Nullable
 String value)

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.