Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnSpacePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnSpacePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.169Z")
@Stability(Stable)
public class CfnSpacePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a private space or a space used for real time collaboration in a domain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnSpacePropsMixin cfnSpacePropsMixin = CfnSpacePropsMixin.Builder.create(CfnSpaceMixinProps.builder()
         .domainId("domainId")
         .ownershipSettings(OwnershipSettingsProperty.builder()
                 .ownerUserProfileName("ownerUserProfileName")
                 .build())
         .spaceDisplayName("spaceDisplayName")
         .spaceName("spaceName")
         .spaceSettings(SpaceSettingsProperty.builder()
                 .appType("appType")
                 .codeEditorAppSettings(SpaceCodeEditorAppSettingsProperty.builder()
                         .appLifecycleManagement(SpaceAppLifecycleManagementProperty.builder()
                                 .idleSettings(SpaceIdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .customFileSystems(List.of(CustomFileSystemProperty.builder()
                         .efsFileSystem(EFSFileSystemProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 .build())
                         .fSxLustreFileSystem(FSxLustreFileSystemProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 .build())
                         .s3FileSystem(S3FileSystemProperty.builder()
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .jupyterLabAppSettings(SpaceJupyterLabAppSettingsProperty.builder()
                         .appLifecycleManagement(SpaceAppLifecycleManagementProperty.builder()
                                 .idleSettings(SpaceIdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .codeRepositories(List.of(CodeRepositoryProperty.builder()
                                 .repositoryUrl("repositoryUrl")
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .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")
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .remoteAccess("remoteAccess")
                 .spaceManagedResources("spaceManagedResources")
                 .spaceStorageSettings(SpaceStorageSettingsProperty.builder()
                         .ebsStorageSettings(EbsStorageSettingsProperty.builder()
                                 .ebsVolumeSizeInGb(123)
                                 .build())
                         .build())
                 .build())
         .spaceSharingSettings(SpaceSharingSettingsProperty.builder()
                 .sharingType("sharingType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSpacePropsMixin.Builder	A fluent builder for CfnSpacePropsMixin.
static interface	CfnSpacePropsMixin.CodeRepositoryProperty	A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
static interface	CfnSpacePropsMixin.CustomFileSystemProperty	A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnSpacePropsMixin.CustomImageProperty	A custom SageMaker AI image.
static interface	CfnSpacePropsMixin.EbsStorageSettingsProperty	A collection of EBS storage settings that apply to both private and shared spaces.
static interface	CfnSpacePropsMixin.EFSFileSystemProperty	A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnSpacePropsMixin.FSxLustreFileSystemProperty	A custom file system in Amazon FSx for Lustre.
static interface	CfnSpacePropsMixin.JupyterServerAppSettingsProperty	The JupyterServer app settings.
static interface	CfnSpacePropsMixin.KernelGatewayAppSettingsProperty	The KernelGateway app settings.
static interface	CfnSpacePropsMixin.OwnershipSettingsProperty	The collection of ownership settings for a space.
static interface	CfnSpacePropsMixin.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	CfnSpacePropsMixin.S3FileSystemProperty	A custom file system in Amazon S3.
static interface	CfnSpacePropsMixin.SpaceAppLifecycleManagementProperty	Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.
static interface	CfnSpacePropsMixin.SpaceCodeEditorAppSettingsProperty	The application settings for a Code Editor space.
static interface	CfnSpacePropsMixin.SpaceIdleSettingsProperty	Settings related to idle shutdown of Studio applications in a space.
static interface	CfnSpacePropsMixin.SpaceJupyterLabAppSettingsProperty	The settings for the JupyterLab application within a space.
static interface	CfnSpacePropsMixin.SpaceSettingsProperty	A collection of space settings.
static interface	CfnSpacePropsMixin.SpaceSharingSettingsProperty	A collection of space sharing settings.
static interface	CfnSpacePropsMixin.SpaceStorageSettingsProperty	The storage settings for a space.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnSpacePropsMixin(CfnSpaceMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::Space.
	CfnSpacePropsMixin(CfnSpaceMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::Space.
protected	CfnSpacePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSpacePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnSpaceMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnSpacePropsMixin

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

CfnSpacePropsMixin

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

CfnSpacePropsMixin

@Stability(Stable)
public CfnSpacePropsMixin(@NotNull
 CfnSpaceMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::Space.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnSpacePropsMixin

@Stability(Stable)
public CfnSpacePropsMixin(@NotNull
 CfnSpaceMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::Space.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnSpaceMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()