aws-cdk-lib.aws_sagemaker.CfnDomainProps

interface CfnDomainProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnDomainProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnDomainProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnDomainProps
Pythonaws_cdk.aws_sagemaker.CfnDomainProps
TypeScript aws-cdk-lib » aws_sagemaker » CfnDomainProps

Properties for defining a CfnDomain.

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 cfnDomainProps: sagemaker.CfnDomainProps = {
  authMode: 'authMode',
  defaultUserSettings: {
    executionRole: 'executionRole',

    // the properties below are optional
    jupyterServerAppSettings: {
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    kernelGatewayAppSettings: {
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',

        // the properties below are optional
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    rSessionAppSettings: {
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',

        // the properties below are optional
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    rStudioServerProAppSettings: {
      accessStatus: 'accessStatus',
      userGroup: 'userGroup',
    },
    securityGroups: ['securityGroups'],
    sharingSettings: {
      notebookOutputOption: 'notebookOutputOption',
      s3KmsKeyId: 's3KmsKeyId',
      s3OutputPath: 's3OutputPath',
    },
  },
  domainName: 'domainName',
  subnetIds: ['subnetIds'],
  vpcId: 'vpcId',

  // the properties below are optional
  appNetworkAccessType: 'appNetworkAccessType',
  appSecurityGroupManagement: 'appSecurityGroupManagement',
  defaultSpaceSettings: {
    executionRole: 'executionRole',

    // the properties below are optional
    jupyterServerAppSettings: {
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    kernelGatewayAppSettings: {
      customImages: [{
        appImageConfigName: 'appImageConfigName',
        imageName: 'imageName',

        // the properties below are optional
        imageVersionNumber: 123,
      }],
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
    },
    securityGroups: ['securityGroups'],
  },
  domainSettings: {
    rStudioServerProDomainSettings: {
      domainExecutionRoleArn: 'domainExecutionRoleArn',

      // the properties below are optional
      defaultResourceSpec: {
        instanceType: 'instanceType',
        lifecycleConfigArn: 'lifecycleConfigArn',
        sageMakerImageArn: 'sageMakerImageArn',
        sageMakerImageVersionArn: 'sageMakerImageVersionArn',
      },
      rStudioConnectUrl: 'rStudioConnectUrl',
      rStudioPackageManagerUrl: 'rStudioPackageManagerUrl',
    },
    securityGroupIds: ['securityGroupIds'],
  },
  kmsKeyId: 'kmsKeyId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
authModestringThe mode of authentication that members use to access the Domain.
defaultUserSettingsIResolvable | UserSettingsPropertyThe default user settings.
domainNamestringThe domain name.
subnetIdsstring[]The VPC subnets that Studio uses for communication.
vpcIdstringThe ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.
appNetworkAccessType?stringSpecifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .
appSecurityGroupManagement?stringThe entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
defaultSpaceSettings?IResolvable | DefaultSpaceSettingsPropertyAWS::SageMaker::Domain.DefaultSpaceSettings.
domainSettings?IResolvable | DomainSettingsPropertyA collection of settings that apply to the SageMaker Domain .
kmsKeyId?stringSageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.
tags?CfnTag[]Tags to associated with the Domain.

authMode

Type: string

The mode of authentication that members use to access the Domain.

Valid Values : SSO | IAM


defaultUserSettings

Type: IResolvable | UserSettingsProperty

The default user settings.


domainName

Type: string

The domain name.


subnetIds

Type: string[]

The VPC subnets that Studio uses for communication.

Length Constraints : Maximum length of 32.

Array members : Minimum number of 1 item. Maximum number of 16 items.

Pattern : [-0-9a-zA-Z]+


vpcId

Type: string

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Length Constraints : Maximum length of 32.

Pattern : [-0-9a-zA-Z]+


appNetworkAccessType?

Type: string (optional)

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access
  • VpcOnly - All Studio traffic is through the specified VPC and subnets

Valid Values : PublicInternetOnly | VpcOnly


appSecurityGroupManagement?

Type: string (optional)

The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.

Required when CreateDomain.AppNetworkAccessType is VpcOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service .

Allowed Values : Service | Customer


defaultSpaceSettings?

Type: IResolvable | DefaultSpaceSettingsProperty (optional)

AWS::SageMaker::Domain.DefaultSpaceSettings.


domainSettings?

Type: IResolvable | DomainSettingsProperty (optional)

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.


kmsKeyId?

Type: string (optional)

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.

For more control, specify a customer managed CMK.

Length Constraints : Maximum length of 2048.

Pattern : .*


tags?

Type: CfnTag[] (optional)

Tags to associated with the Domain.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all apps that are launched in the Domain.

Array members : Minimum number of 0 items. Maximum number of 50 items.