interface CfnDomainProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Sagemaker.CfnDomainProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnDomainProps |
![]() | software.amazon.awscdk.services.sagemaker.CfnDomainProps |
![]() | aws_cdk.aws_sagemaker.CfnDomainProps |
![]() | aws-cdk-lib » aws_sagemaker » CfnDomainProps |
Properties for defining a CfnDomain
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.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 cfnDomainProps: sagemaker.CfnDomainProps = {
authMode: 'authMode',
defaultUserSettings: {
executionRole: 'executionRole',
// the properties below are optional
codeEditorAppSettings: {
appLifecycleManagement: {
idleSettings: {
idleTimeoutInMinutes: 123,
lifecycleManagement: 'lifecycleManagement',
maxIdleTimeoutInMinutes: 123,
minIdleTimeoutInMinutes: 123,
},
},
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
customFileSystemConfigs: [{
efsFileSystemConfig: {
fileSystemId: 'fileSystemId',
// the properties below are optional
fileSystemPath: 'fileSystemPath',
},
fSxLustreFileSystemConfig: {
fileSystemId: 'fileSystemId',
// the properties below are optional
fileSystemPath: 'fileSystemPath',
},
}],
customPosixUserConfig: {
gid: 123,
uid: 123,
},
defaultLandingUri: 'defaultLandingUri',
jupyterLabAppSettings: {
appLifecycleManagement: {
idleSettings: {
idleTimeoutInMinutes: 123,
lifecycleManagement: 'lifecycleManagement',
maxIdleTimeoutInMinutes: 123,
minIdleTimeoutInMinutes: 123,
},
},
codeRepositories: [{
repositoryUrl: 'repositoryUrl',
}],
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
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'],
},
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',
},
spaceStorageSettings: {
defaultEbsStorageSettings: {
defaultEbsVolumeSizeInGb: 123,
maximumEbsVolumeSizeInGb: 123,
},
},
studioWebPortal: 'studioWebPortal',
studioWebPortalSettings: {
hiddenAppTypes: ['hiddenAppTypes'],
hiddenMlTools: ['hiddenMlTools'],
},
},
domainName: 'domainName',
subnetIds: ['subnetIds'],
vpcId: 'vpcId',
// the properties below are optional
appNetworkAccessType: 'appNetworkAccessType',
appSecurityGroupManagement: 'appSecurityGroupManagement',
defaultSpaceSettings: {
executionRole: 'executionRole',
// the properties below are optional
customFileSystemConfigs: [{
efsFileSystemConfig: {
fileSystemId: 'fileSystemId',
// the properties below are optional
fileSystemPath: 'fileSystemPath',
},
fSxLustreFileSystemConfig: {
fileSystemId: 'fileSystemId',
// the properties below are optional
fileSystemPath: 'fileSystemPath',
},
}],
customPosixUserConfig: {
gid: 123,
uid: 123,
},
jupyterLabAppSettings: {
appLifecycleManagement: {
idleSettings: {
idleTimeoutInMinutes: 123,
lifecycleManagement: 'lifecycleManagement',
maxIdleTimeoutInMinutes: 123,
minIdleTimeoutInMinutes: 123,
},
},
codeRepositories: [{
repositoryUrl: 'repositoryUrl',
}],
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
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'],
},
securityGroups: ['securityGroups'],
spaceStorageSettings: {
defaultEbsStorageSettings: {
defaultEbsVolumeSizeInGb: 123,
maximumEbsVolumeSizeInGb: 123,
},
},
},
domainSettings: {
dockerSettings: {
enableDockerAccess: 'enableDockerAccess',
vpcOnlyTrustedAccounts: ['vpcOnlyTrustedAccounts'],
},
executionRoleIdentityConfig: 'executionRoleIdentityConfig',
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',
tagPropagation: 'tagPropagation',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
auth | string | The mode of authentication that members use to access the Domain. |
default | IResolvable | User | The default user settings. |
domain | string | The domain name. |
subnet | string[] | The VPC subnets that Studio uses for communication. |
vpc | string | The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. |
app | string | Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly . |
app | string | The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode. |
default | IResolvable | Default | The default settings for shared spaces that users create in the domain. |
domain | IResolvable | Domain | A collection of settings that apply to the SageMaker Domain . |
kms | string | SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. |
tag | string | Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources. |
tags? | Cfn [] | 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
|
User
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 AI , which allows direct internet accessVpcOnly
- 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
|
Default
(optional)
The default settings for shared spaces that users create in the domain.
SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
domainSettings?
Type:
IResolvable
|
Domain
(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 : .*
tagPropagation?
Type:
string
(optional)
Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
tags?
Type:
Cfn
[]
(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.