java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
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:
  • 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.