DomainSettingsProperty Struct
A collection of settings that apply to the SageMaker Domain .
These settings are specified through the CreateDomain API call.
Example
ts
// 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 domainSettingsProperty: sagemaker.CfnDomain.DomainSettingsProperty = {
dockerSettings: {
enableDockerAccess: 'enableDockerAccess',
vpcOnlyTrustedAccounts: ['vpcOnlyTrustedAccounts'],
},
executionRoleIdentityConfig: 'executionRoleIdentityConfig',
ipAddressType: 'ipAddressType',
rStudioServerProDomainSettings: {
domainExecutionRoleArn: 'domainExecutionRoleArn',
// the properties below are optional
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
trainingPlanArn: 'trainingPlanArn',
},
rStudioConnectUrl: 'rStudioConnectUrl',
rStudioPackageManagerUrl: 'rStudioPackageManagerUrl',
},
securityGroupIds: ['securityGroupIds'],
unifiedStudioSettings: {
domainAccountId: 'domainAccountId',
domainId: 'domainId',
domainRegion: 'domainRegion',
environmentId: 'environmentId',
projectId: 'projectId',
projectS3Path: 'projectS3Path',
studioWebPortalAccess: 'studioWebPortalAccess',
},
};
Properties
dockerSettingsoptionalIResolvable | CfnDomain.DockerSettingsPropertydocker_settingsoptionaltyping.Union[IResolvable, DockerSettingsProperty]dockerSettingsoptionalIResolvableDockerSettingsoptionalIResolvableDockerSettingsoptionalinterface{}#A collection of settings that configure the domain's Docker interaction.
executionRoleIdentityConfigoptionalstringexecution_role_identity_configoptionalstrexecutionRoleIdentityConfigoptionalStringExecutionRoleIdentityConfigoptionalstringExecutionRoleIdentityConfigoptional*string#The configuration for attaching a SageMaker AI user profile name to the execution role as a [sts:SourceIdentity key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html) .
ipAddressTypeoptionalstringip_address_typeoptionalstripAddressTypeoptionalStringIpAddressTypeoptionalstringIpAddressTypeoptional*string#The IP address type for the domain.
Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack , the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4 .
rStudioServerProDomainSettingsoptionalIResolvable | CfnDomain.RStudioServerProDomainSettingsPropertyr_studio_server_pro_domain_settingsoptionaltyping.Union[IResolvable, RStudioServerProDomainSettingsProperty]rStudioServerProDomainSettingsoptionalIResolvableRStudioServerProDomainSettingsoptionalIResolvableRStudioServerProDomainSettingsoptionalinterface{}#A collection of settings that configure the `RStudioServerPro` Domain-level app.
securityGroupIdsoptionalstring[]security_group_idsoptionaltyping.List[str]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]*string#The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
unifiedStudioSettingsoptionalIResolvable | CfnDomain.UnifiedStudioSettingsPropertyunified_studio_settingsoptionaltyping.Union[IResolvable, UnifiedStudioSettingsProperty]unifiedStudioSettingsoptionalIResolvableUnifiedStudioSettingsoptionalIResolvableUnifiedStudioSettingsoptionalinterface{}#The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.