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.104.0 (build e79254c)",
date="2024-11-21T06:34:15.842Z")
@Stability(Stable)
public class CfnSpace
extends CfnResource
implements IInspectable, ITaggable
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.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() .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()) .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") // 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()) .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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnSpace
.static interface
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.static interface
A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain.static interface
A custom SageMaker image.static interface
A collection of EBS storage settings that apply to both private and shared spaces.static interface
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
The JupyterServer app settings.static interface
The KernelGateway app settings.static interface
The collection of ownership settings for a space.static interface
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.static interface
Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.static interface
The application settings for a Code Editor space.static interface
Settings related to idle shutdown of Studio applications in a space.static interface
The settings for the JupyterLab application within a space.static interface
A collection of space settings.static interface
A collection of space sharing settings.static interface
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe space's Amazon Resource Name (ARN).Returns the URL of the space.The ID of the associated domain.The collection of ownership settings for a space.The name of the space that appears in the Studio UI.The name of the space.A collection of space settings.A collection of space sharing settings.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
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
A collection of space settings.void
A collection of space sharing settings.void
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrSpaceArn
The space's Amazon Resource Name (ARN). -
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
- Studio Classic:
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDomainId
The ID of the associated domain. -
setDomainId
The ID of the associated domain. -
getSpaceName
The name of the space. -
setSpaceName
The name of the space. -
getOwnershipSettings
The collection of ownership settings for a space. -
setOwnershipSettings
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
The name of the space that appears in the Studio UI. -
setSpaceDisplayName
The name of the space that appears in the Studio UI. -
getSpaceSettings
A collection of space settings. -
setSpaceSettings
A collection of space settings. -
setSpaceSettings
A collection of space settings. -
getSpaceSharingSettings
A collection of space sharing settings. -
setSpaceSharingSettings
A collection of space sharing settings. -
setSpaceSharingSettings
@Stability(Stable) public void setSpaceSharingSettings(@Nullable CfnSpace.SpaceSharingSettingsProperty value) A collection of space sharing settings. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-