Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.UnifiedStudioSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.UnifiedStudioSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.UnifiedStudioSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 UnifiedStudioSettingsProperty unifiedStudioSettingsProperty = UnifiedStudioSettingsProperty.builder()
         .domainAccountId("domainAccountId")
         .domainId("domainId")
         .domainRegion("domainRegion")
         .environmentId("environmentId")
         .projectId("projectId")
         .projectS3Path("projectS3Path")
         .studioWebPortalAccess("studioWebPortalAccess")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.UnifiedStudioSettingsProperty.Builder	A builder for CfnDomain.UnifiedStudioSettingsProperty
static final class	CfnDomain.UnifiedStudioSettingsProperty.Jsii$Proxy	An implementation for CfnDomain.UnifiedStudioSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.UnifiedStudioSettingsProperty.Builder	builder()
default String	getDomainAccountId()	The ID of the AWS account that has the Amazon SageMaker Unified Studio domain.
default String	getDomainId()	The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
default String	getDomainRegion()	The AWS Region where the domain is located in Amazon SageMaker Unified Studio.
default String	getEnvironmentId()	The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
default String	getProjectId()	The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
default String	getProjectS3Path()	The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
default String	getStudioWebPortalAccess()	Sets whether you can access the domain in Amazon SageMaker Studio:.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainAccountId

@Stability(Stable)
@Nullable
default String getDomainAccountId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainaccountid

getDomainId

@Stability(Stable)
@Nullable
default String getDomainId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainid

getDomainRegion

@Stability(Stable)
@Nullable
default String getDomainRegion()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-domainregion

getEnvironmentId

@Stability(Stable)
@Nullable
default String getEnvironmentId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-environmentid

getProjectId

@Stability(Stable)
@Nullable
default String getProjectId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projectid

getProjectS3Path

@Stability(Stable)
@Nullable
default String getProjectS3Path()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-projects3path

getStudioWebPortalAccess

@Stability(Stable)
@Nullable
default String getStudioWebPortalAccess()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-unifiedstudiosettings.html#cfn-sagemaker-domain-unifiedstudiosettings-studiowebportalaccess

builder

@Stability(Stable)
static CfnDomain.UnifiedStudioSettingsProperty.Builder builder()

Returns:

a CfnDomain.UnifiedStudioSettingsProperty.Builder of CfnDomain.UnifiedStudioSettingsProperty