interface CfnSpaceProps

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnSpaceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnSpaceProps
Java	software.amazon.awscdk.services.sagemaker.CfnSpaceProps
Python	aws_cdk.aws_sagemaker.CfnSpaceProps
TypeScript	aws-cdk-lib » aws_sagemaker » CfnSpaceProps

Properties for defining a CfnSpace.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnSpaceProps: sagemaker.CfnSpaceProps = {
  domainId: 'domainId',
  spaceName: 'spaceName',

  // the properties below are optional
  ownershipSettings: {
    ownerUserProfileName: 'ownerUserProfileName',
  },
  spaceDisplayName: 'spaceDisplayName',
  spaceSettings: {
    appType: 'appType',
    codeEditorAppSettings: {
      appLifecycleManagement: {
        idleSettings: {
          idleTimeoutInMinutes: 123,
        },
      },
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    customFileSystems: [{
      efsFileSystem: {
        fileSystemId: 'fileSystemId',
      },
      fSxLustreFileSystem: {
        fileSystemId: 'fileSystemId',
      },
    }],
    jupyterLabAppSettings: {
      appLifecycleManagement: {
        idleSettings: {
          idleTimeoutInMinutes: 123,
        },
      },
      codeRepositories: [{
        repositoryUrl: 'repositoryUrl',
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    jupyterServerAppSettings: {
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
      lifecycleConfigArns: ['lifecycleConfigArns'],
    },
    kernelGatewayAppSettings: {
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',

        // the properties below are optional
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
      lifecycleConfigArns: ['lifecycleConfigArns'],
    },
    spaceStorageSettings: {
      ebsStorageSettings: {
        ebsVolumeSizeInGb: 123,
      },
    },
  },
  spaceSharingSettings: {
    sharingType: 'sharingType',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
domainId	string	The ID of the associated domain.
spaceName	string	The name of the space.
ownershipSettings?	IResolvable | OwnershipSettingsProperty	The collection of ownership settings for a space.
spaceDisplayName?	string	The name of the space that appears in the Studio UI.
spaceSettings?	IResolvable | SpaceSettingsProperty	A collection of space settings.
spaceSharingSettings?	IResolvable | SpaceSharingSettingsProperty	A collection of space sharing settings.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

domainId

Type: string

The ID of the associated domain.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-domainid

---

spaceName

Type: string

The name of the space.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacename

---

ownershipSettings?

Type: IResolvable | OwnershipSettingsProperty (optional)

The collection of ownership settings for a space.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-ownershipsettings

---

spaceDisplayName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacedisplayname

---

spaceSettings?

Type: IResolvable | SpaceSettingsProperty (optional)

A collection of space settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacesettings

---

spaceSharingSettings?

Type: IResolvable | SpaceSharingSettingsProperty (optional)

A collection of space sharing settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-spacesharingsettings

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html#cfn-sagemaker-space-tags