Package software.amazon.awscdk.services.sagemaker

Class CfnSpace

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:13.613Z")
@Stability(Stable)
public class CfnSpace
extends CfnResource
implements IInspectable, ITaggable

Creates 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.services.sagemaker.*;
 CfnSpace cfnSpace = CfnSpace.Builder.create(this, "MyCfnSpace")
         .domainId("domainId")
         .spaceName("spaceName")
         // the properties below are optional
         .ownershipSettings(OwnershipSettingsProperty.builder()
                 .ownerUserProfileName("ownerUserProfileName")
                 .build())
         .spaceDisplayName("spaceDisplayName")
         .spaceSettings(SpaceSettingsProperty.builder()
                 .appType("appType")
                 .codeEditorAppSettings(SpaceCodeEditorAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .customFileSystems(List.of(CustomFileSystemProperty.builder()
                         .efsFileSystem(EFSFileSystemProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 .build())
                         .build()))
                 .jupyterLabAppSettings(SpaceJupyterLabAppSettingsProperty.builder()
                         .codeRepositories(List.of(CodeRepositoryProperty.builder()
                                 .repositoryUrl("repositoryUrl")
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .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")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .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();
 

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	CfnSpace.Builder	A fluent builder for CfnSpace.
static interface	CfnSpace.CodeRepositoryProperty	A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
static interface	CfnSpace.CustomFileSystemProperty	A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain.
static interface	CfnSpace.CustomImageProperty	A custom SageMaker image.
static interface	CfnSpace.EbsStorageSettingsProperty	A collection of EBS storage settings that apply to both private and shared spaces.
static interface	CfnSpace.EFSFileSystemProperty	A file system, created by you in Amazon EFS, that you assign to a user profile or space for an Amazon SageMaker Domain.
static interface	CfnSpace.JupyterServerAppSettingsProperty	The JupyterServer app settings.
static interface	CfnSpace.KernelGatewayAppSettingsProperty	The KernelGateway app settings.
static interface	CfnSpace.OwnershipSettingsProperty	The collection of ownership settings for a space.
static interface	CfnSpace.ResourceSpecProperty	Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
static interface	CfnSpace.SpaceCodeEditorAppSettingsProperty	The application settings for a Code Editor space.
static interface	CfnSpace.SpaceJupyterLabAppSettingsProperty	The settings for the JupyterLab application within a space.
static interface	CfnSpace.SpaceSettingsProperty	A collection of space settings.
static interface	CfnSpace.SpaceSharingSettingsProperty	A collection of space sharing settings.
static interface	CfnSpace.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.IConstruct

software.constructs.IConstruct.Jsii$Default

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	CfnSpace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSpace(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSpace(software.constructs.Construct scope, String id, CfnSpaceProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrSpaceArn()	The space's Amazon Resource Name (ARN).
String	getAttrUrl()	Returns the URL of the space.
protected Map<String,Object>	getCfnProperties()
String	getDomainId()	The ID of the associated domain.
Object	getOwnershipSettings()	The collection of ownership settings for a space.
String	getSpaceDisplayName()	The name of the space that appears in the Studio UI.
String	getSpaceName()	The name of the space.
Object	getSpaceSettings()	A collection of space settings.
Object	getSpaceSharingSettings()	A collection of space sharing settings.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainId(String value)	The ID of the associated domain.
void	setOwnershipSettings(IResolvable value)	The collection of ownership settings for a space.
void	setOwnershipSettings(CfnSpace.OwnershipSettingsProperty value)	The collection of ownership settings for a space.
void	setSpaceDisplayName(String value)	The name of the space that appears in the Studio UI.
void	setSpaceName(String value)	The name of the space.
void	setSpaceSettings(IResolvable value)	A collection of space settings.
void	setSpaceSettings(CfnSpace.SpaceSettingsProperty value)	A collection of space settings.
void	setSpaceSharingSettings(IResolvable value)	A collection of space sharing settings.
void	setSpaceSharingSettings(CfnSpace.SpaceSharingSettingsProperty value)	A collection of space sharing settings.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.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

CfnSpace

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

CfnSpace

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

CfnSpace

@Stability(Stable)
public CfnSpace(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSpaceProps 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

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.

getAttrSpaceArn

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

The space's Amazon Resource Name (ARN).

getAttrUrl

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

Returns the URL of the space.

If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center.

The following application types are supported:

• Studio Classic: &redirect=JupyterServer
• JupyterLab: &redirect=JupyterLab
• Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDomainId

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

The ID of the associated domain.

setDomainId

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

The ID of the associated domain.

getSpaceName

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

The name of the space.

setSpaceName

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

The name of the space.

getOwnershipSettings

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

The collection of ownership settings for a space.

setOwnershipSettings

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

The collection of ownership settings for a space.

setOwnershipSettings

@Stability(Stable)
public void setOwnershipSettings(@Nullable
 CfnSpace.OwnershipSettingsProperty value)

The collection of ownership settings for a space.

getSpaceDisplayName

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

The name of the space that appears in the Studio UI.

setSpaceDisplayName

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

The name of the space that appears in the Studio UI.

getSpaceSettings

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

A collection of space settings.

setSpaceSettings

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

A collection of space settings.

setSpaceSettings

@Stability(Stable)
public void setSpaceSettings(@Nullable
 CfnSpace.SpaceSettingsProperty value)

A collection of space settings.

getSpaceSharingSettings

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

A collection of space sharing settings.

setSpaceSharingSettings

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

A collection of space sharing settings.

setSpaceSharingSettings

@Stability(Stable)
public void setSpaceSharingSettings(@Nullable
 CfnSpace.SpaceSharingSettingsProperty value)

A collection of space sharing settings.

getTagsRaw

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

An array of key-value pairs to apply to this resource.

setTagsRaw

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

An array of key-value pairs to apply to this resource.