Package software.amazon.awscdk.services.sagemaker

Class CfnSpace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnSpace
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.528Z") @Stability(Stable) public class CfnSpace extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::Space.

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
         .spaceSettings(SpaceSettingsProperty.builder()
                 .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())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnSpaceProps props)
      Create a new AWS::SageMaker::Space.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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).

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

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

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