Class: AWSCDK::Sagemaker::CfnDomain::UnifiedStudioSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_domain.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_account_id: nil, domain_id: nil, domain_region: nil, environment_id: nil, project_id: nil, project_s3_path: nil, studio_web_portal_access: nil) ⇒ UnifiedStudioSettingsProperty

Returns a new instance of UnifiedStudioSettingsProperty.

Parameters:

  • domain_account_id (String, nil) (defaults to: nil) —

    The ID of the AWS account that has the Amazon SageMaker Unified Studio domain.

  • domain_id (String, nil) (defaults to: nil) —

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

  • domain_region (String, nil) (defaults to: nil) —

    The AWS Region where the domain is located in Amazon SageMaker Unified Studio.

  • environment_id (String, nil) (defaults to: nil) —

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

  • project_id (String, nil) (defaults to: nil) —

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

  • project_s3_path (String, nil) (defaults to: nil) —

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

  • studio_web_portal_access (String, nil) (defaults to: nil) —

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



2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'sagemaker/cfn_domain.rb', line 2182

def initialize(domain_account_id: nil, domain_id: nil, domain_region: nil, environment_id: nil, project_id: nil, project_s3_path: nil, studio_web_portal_access: nil)
  @domain_account_id = 
  Jsii::Type.check_type(@domain_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainAccountId") unless @domain_account_id.nil?
  @domain_id = domain_id
  Jsii::Type.check_type(@domain_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainId") unless @domain_id.nil?
  @domain_region = domain_region
  Jsii::Type.check_type(@domain_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainRegion") unless @domain_region.nil?
  @environment_id = environment_id
  Jsii::Type.check_type(@environment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId") unless @environment_id.nil?
  @project_id = project_id
  Jsii::Type.check_type(@project_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectId") unless @project_id.nil?
  @project_s3_path = project_s3_path
  Jsii::Type.check_type(@project_s3_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectS3Path") unless @project_s3_path.nil?
  @studio_web_portal_access = studio_web_portal_access
  Jsii::Type.check_type(@studio_web_portal_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "studioWebPortalAccess") unless @studio_web_portal_access.nil?
end

Instance Attribute Details

#domain_account_id ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2205
2206
2207
 
# File 'sagemaker/cfn_domain.rb', line 2205

def 
  @domain_account_id
end

#domain_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2210
2211
2212
 
# File 'sagemaker/cfn_domain.rb', line 2210

def domain_id
  @domain_id
end

#domain_region ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2217
2218
2219
 
# File 'sagemaker/cfn_domain.rb', line 2217

def domain_region
  @domain_region
end

#environment_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2222
2223
2224
 
# File 'sagemaker/cfn_domain.rb', line 2222

def environment_id
  @environment_id
end

#project_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2227
2228
2229
 
# File 'sagemaker/cfn_domain.rb', line 2227

def project_id
  @project_id
end

#project_s3_path ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2232
2233
2234
 
# File 'sagemaker/cfn_domain.rb', line 2232

def project_s3_path
  @project_s3_path
end

#studio_web_portal_access ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



2242
2243
2244
 
# File 'sagemaker/cfn_domain.rb', line 2242

def studio_web_portal_access
  @studio_web_portal_access
end

Class Method Details

.jsii_properties ⇒ Object 



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'sagemaker/cfn_domain.rb', line 2244

def self.jsii_properties
  {
    :domain_account_id => "domainAccountId",
    :domain_id => "domainId",
    :domain_region => "domainRegion",
    :environment_id => "environmentId",
    :project_id => "projectId",
    :project_s3_path => "projectS3Path",
    :studio_web_portal_access => "studioWebPortalAccess",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'sagemaker/cfn_domain.rb', line 2256

def to_jsii
  result = {}
  result.merge!({
    "domainAccountId" => @domain_account_id,
    "domainId" => @domain_id,
    "domainRegion" => @domain_region,
    "environmentId" => @environment_id,
    "projectId" => @project_id,
    "projectS3Path" => @project_s3_path,
    "studioWebPortalAccess" => @studio_web_portal_access,
  })
  result.compact
end