AWS::SageMaker::Domain UnifiedStudioSettings - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::Domain UnifiedStudioSettings

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DomainAccountId" : String,
  "DomainId" : String,
  "DomainRegion" : String,
  "EnvironmentId" : String,
  "ProjectId" : String,
  "ProjectS3Path" : String,
  "StudioWebPortalAccess" : String
}

YAML

  DomainAccountId: String
  DomainId: String
  DomainRegion: String
  EnvironmentId: String
  ProjectId: String
  ProjectS3Path: String
  StudioWebPortalAccess: String

Properties

DomainAccountId

The ID of the AWS account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.

Required: No

Type: String

Pattern: ^\d+$

Minimum: 12

Maximum: 12

Update requires: No interruption

DomainId

The ID of the Amazon SageMaker Unified Studio domain associated with this domain.

Required: No

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Minimum: 1

Maximum: 36

Update requires: No interruption

DomainRegion

The AWS Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.

Required: No

Type: String

Pattern: [a-zA-Z]{2}-[a-zA-Z\-]+-\d+

Update requires: No interruption

EnvironmentId

The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Minimum: 1

Maximum: 36

Update requires: No interruption

ProjectId

The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: No interruption

ProjectS3Path

The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.

Required: No

Type: String

Pattern: [\w\.-]+$

Minimum: 1

Maximum: 100

Update requires: No interruption

StudioWebPortalAccess

Sets whether you can access the domain in Amazon SageMaker Studio:

ENABLED

You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.

DISABLED

You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.

To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption