interface DomainSettingsProperty

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

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

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 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',
    },
    rStudioConnectUrl: 'rStudioConnectUrl',
    rStudioPackageManagerUrl: 'rStudioPackageManagerUrl',
  },
  securityGroupIds: ['securityGroupIds'],
  unifiedStudioSettings: {
    domainAccountId: 'domainAccountId',
    domainId: 'domainId',
    domainRegion: 'domainRegion',
    environmentId: 'environmentId',
    projectId: 'projectId',
    projectS3Path: 'projectS3Path',
    studioWebPortalAccess: 'studioWebPortalAccess',
  },
};

Properties

Name	Type	Description
dockerSettings?	`IResolvable` `\|` `DockerSettingsProperty`	A collection of settings that configure the domain's Docker interaction.
executionRoleIdentityConfig?	`string`	The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .
ipAddressType?	`string`	The IP address type for the domain.
rStudioServerProDomainSettings?	`IResolvable` `\|` `RStudioServerProDomainSettingsProperty`	A collection of settings that configure the `RStudioServerPro` Domain-level app.
securityGroupIds?	`string[]`	The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps.
unifiedStudioSettings?	`IResolvable` `\|` `UnifiedStudioSettingsProperty`	The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

dockerSettings?

Type: IResolvable | DockerSettingsProperty (optional)

A collection of settings that configure the domain's Docker interaction.

executionRoleIdentityConfig?

Type: string (optional)

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .

ipAddressType?

Type: string (optional)

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 .

rStudioServerProDomainSettings?

Type: IResolvable | RStudioServerProDomainSettingsProperty (optional)

A collection of settings that configure the RStudioServerPro Domain-level app.

securityGroupIds?

Type: string[] (optional)

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

unifiedStudioSettings?

Type: IResolvable | UnifiedStudioSettingsProperty (optional)

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

AWS CDK

2.232.2