Aws::SageMaker::Model::UnifiedStudioSettings Class Reference

#include <UnifiedStudioSettings.h>

Public Member Functions

AWS_SAGEMAKER_API UnifiedStudioSettings ()=default

 

AWS_SAGEMAKER_API UnifiedStudioSettings (Aws::Utils::Json::JsonView jsonValue)

 

AWS_SAGEMAKER_API UnifiedStudioSettings & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize () const

 

FeatureStatus GetStudioWebPortalAccess () const

 

bool StudioWebPortalAccessHasBeenSet () const

 

void SetStudioWebPortalAccess (FeatureStatus value)

 

UnifiedStudioSettings & WithStudioWebPortalAccess (FeatureStatus value)

 

const Aws::String & GetDomainAccountId () const

 

bool DomainAccountIdHasBeenSet () const

 

template<typename DomainAccountIdT = Aws::String>

void SetDomainAccountId (DomainAccountIdT &&value)

 

template<typename DomainAccountIdT = Aws::String>

UnifiedStudioSettings & WithDomainAccountId (DomainAccountIdT &&value)

 

const Aws::String & GetDomainRegion () const

 

bool DomainRegionHasBeenSet () const

 

template<typename DomainRegionT = Aws::String>

void SetDomainRegion (DomainRegionT &&value)

 

template<typename DomainRegionT = Aws::String>

UnifiedStudioSettings & WithDomainRegion (DomainRegionT &&value)

 

const Aws::String & GetDomainId () const

 

bool DomainIdHasBeenSet () const

 

template<typename DomainIdT = Aws::String>

void SetDomainId (DomainIdT &&value)

 

template<typename DomainIdT = Aws::String>

UnifiedStudioSettings & WithDomainId (DomainIdT &&value)

 

const Aws::String & GetProjectId () const

 

bool ProjectIdHasBeenSet () const

 

template<typename ProjectIdT = Aws::String>

void SetProjectId (ProjectIdT &&value)

 

template<typename ProjectIdT = Aws::String>

UnifiedStudioSettings & WithProjectId (ProjectIdT &&value)

 

const Aws::String & GetEnvironmentId () const

 

bool EnvironmentIdHasBeenSet () const

 

template<typename EnvironmentIdT = Aws::String>

void SetEnvironmentId (EnvironmentIdT &&value)

 

template<typename EnvironmentIdT = Aws::String>

UnifiedStudioSettings & WithEnvironmentId (EnvironmentIdT &&value)

 

const Aws::String & GetProjectS3Path () const

 

bool ProjectS3PathHasBeenSet () const

 

template<typename ProjectS3PathT = Aws::String>

void SetProjectS3Path (ProjectS3PathT &&value)

 

template<typename ProjectS3PathT = Aws::String>

UnifiedStudioSettings & WithProjectS3Path (ProjectS3PathT &&value)

 

const Aws::String & GetSingleSignOnApplicationArn () const

 

bool SingleSignOnApplicationArnHasBeenSet () const

 

template<typename SingleSignOnApplicationArnT = Aws::String>

void SetSingleSignOnApplicationArn (SingleSignOnApplicationArnT &&value)

 

template<typename SingleSignOnApplicationArnT = Aws::String>

UnifiedStudioSettings & WithSingleSignOnApplicationArn (SingleSignOnApplicationArnT &&value)

 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file UnifiedStudioSettings.h.

Constructor & Destructor Documentation

UnifiedStudioSettings() [1/2]

AWS_SAGEMAKER_API Aws::SageMaker::Model::UnifiedStudioSettings::UnifiedStudioSettings ( )

default

UnifiedStudioSettings() [2/2]

AWS_SAGEMAKER_API Aws::SageMaker::Model::UnifiedStudioSettings::UnifiedStudioSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

DomainAccountIdHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::DomainAccountIdHasBeenSet ( ) const

inline

The ID of the Amazon Web Services 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.

Definition at line 67 of file UnifiedStudioSettings.h.

DomainIdHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::DomainIdHasBeenSet ( ) const

inline

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

Definition at line 94 of file UnifiedStudioSettings.h.

DomainRegionHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::DomainRegionHasBeenSet ( ) const

inline

The Amazon Web Services 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.

Definition at line 81 of file UnifiedStudioSettings.h.

EnvironmentIdHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::EnvironmentIdHasBeenSet ( ) const

inline

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

Definition at line 120 of file UnifiedStudioSettings.h.

GetDomainAccountId()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetDomainAccountId ( ) const

inline

The ID of the Amazon Web Services 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.

Definition at line 66 of file UnifiedStudioSettings.h.

GetDomainId()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetDomainId ( ) const

inline

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

Definition at line 93 of file UnifiedStudioSettings.h.

GetDomainRegion()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetDomainRegion ( ) const

inline

The Amazon Web Services 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.

Definition at line 80 of file UnifiedStudioSettings.h.

GetEnvironmentId()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetEnvironmentId ( ) const

inline

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

Definition at line 119 of file UnifiedStudioSettings.h.

GetProjectId()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetProjectId ( ) const

inline

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

Definition at line 106 of file UnifiedStudioSettings.h.

GetProjectS3Path()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetProjectS3Path ( ) const

inline

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

Definition at line 132 of file UnifiedStudioSettings.h.

GetSingleSignOnApplicationArn()

const Aws::String & Aws::SageMaker::Model::UnifiedStudioSettings::GetSingleSignOnApplicationArn ( ) const

inline

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

Definition at line 145 of file UnifiedStudioSettings.h.

GetStudioWebPortalAccess()

FeatureStatus Aws::SageMaker::Model::UnifiedStudioSettings::GetStudioWebPortalAccess ( ) const

inline

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.

Definition at line 54 of file UnifiedStudioSettings.h.

Jsonize()

AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Aws::SageMaker::Model::UnifiedStudioSettings::Jsonize ( ) const

operator=()

AWS_SAGEMAKER_API UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

ProjectIdHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::ProjectIdHasBeenSet ( ) const

inline

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

Definition at line 107 of file UnifiedStudioSettings.h.

ProjectS3PathHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::ProjectS3PathHasBeenSet ( ) const

inline

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

Definition at line 133 of file UnifiedStudioSettings.h.

SetDomainAccountId()

template<typename DomainAccountIdT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetDomainAccountId ( DomainAccountIdT &&  value)

inline

The ID of the Amazon Web Services 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.

Definition at line 69 of file UnifiedStudioSettings.h.

SetDomainId()

template<typename DomainIdT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetDomainId ( DomainIdT &&  value)

inline

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

Definition at line 96 of file UnifiedStudioSettings.h.

SetDomainRegion()

template<typename DomainRegionT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetDomainRegion ( DomainRegionT &&  value)

inline

The Amazon Web Services 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.

Definition at line 83 of file UnifiedStudioSettings.h.

SetEnvironmentId()

template<typename EnvironmentIdT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetEnvironmentId ( EnvironmentIdT &&  value)

inline

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

Definition at line 122 of file UnifiedStudioSettings.h.

SetProjectId()

template<typename ProjectIdT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetProjectId ( ProjectIdT &&  value)

inline

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

Definition at line 109 of file UnifiedStudioSettings.h.

SetProjectS3Path()

template<typename ProjectS3PathT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetProjectS3Path ( ProjectS3PathT &&  value)

inline

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

Definition at line 135 of file UnifiedStudioSettings.h.

SetSingleSignOnApplicationArn()

template<typename SingleSignOnApplicationArnT = Aws::String>

void Aws::SageMaker::Model::UnifiedStudioSettings::SetSingleSignOnApplicationArn ( SingleSignOnApplicationArnT &&  value)

inline

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

Definition at line 148 of file UnifiedStudioSettings.h.

SetStudioWebPortalAccess()

void Aws::SageMaker::Model::UnifiedStudioSettings::SetStudioWebPortalAccess ( FeatureStatus  value)

inline

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.

Definition at line 56 of file UnifiedStudioSettings.h.

SingleSignOnApplicationArnHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::SingleSignOnApplicationArnHasBeenSet ( ) const

inline

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

Definition at line 146 of file UnifiedStudioSettings.h.

StudioWebPortalAccessHasBeenSet()

bool Aws::SageMaker::Model::UnifiedStudioSettings::StudioWebPortalAccessHasBeenSet ( ) const

inline

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.

Definition at line 55 of file UnifiedStudioSettings.h.

WithDomainAccountId()

template<typename DomainAccountIdT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithDomainAccountId ( DomainAccountIdT &&  value)

inline

The ID of the Amazon Web Services 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.

Definition at line 71 of file UnifiedStudioSettings.h.

WithDomainId()

template<typename DomainIdT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithDomainId ( DomainIdT &&  value)

inline

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

Definition at line 98 of file UnifiedStudioSettings.h.

WithDomainRegion()

template<typename DomainRegionT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithDomainRegion ( DomainRegionT &&  value)

inline

The Amazon Web Services 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.

Definition at line 85 of file UnifiedStudioSettings.h.

WithEnvironmentId()

template<typename EnvironmentIdT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithEnvironmentId ( EnvironmentIdT &&  value)

inline

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

Definition at line 124 of file UnifiedStudioSettings.h.

WithProjectId()

template<typename ProjectIdT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithProjectId ( ProjectIdT &&  value)

inline

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

Definition at line 111 of file UnifiedStudioSettings.h.

WithProjectS3Path()

template<typename ProjectS3PathT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithProjectS3Path ( ProjectS3PathT &&  value)

inline

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

Definition at line 137 of file UnifiedStudioSettings.h.

WithSingleSignOnApplicationArn()

template<typename SingleSignOnApplicationArnT = Aws::String>

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithSingleSignOnApplicationArn ( SingleSignOnApplicationArnT &&  value)

inline

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

Definition at line 150 of file UnifiedStudioSettings.h.

WithStudioWebPortalAccess()

UnifiedStudioSettings & Aws::SageMaker::Model::UnifiedStudioSettings::WithStudioWebPortalAccess ( FeatureStatus  value)

inline

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.

Definition at line 57 of file UnifiedStudioSettings.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/UnifiedStudioSettings.h